Added README

1 files changed, 45 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d3e6a0a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+"Save as image map" Inkscape extension
+======================================
+
+Enables [Inkscape][1] to turn hyperlinked SVGs into [image maps][2].
+Supports HTML, XHTML, and [mod_imagemap][3] formats. Requires Inkscape 1.4.3
+or newer, due to changes in the path-split feature.
+
+[1]: https://inkscape.org
+[2]: https://en.wikipedia.org/wiki/Image_map
+[3]: https://httpd.apache.org/docs/current/mod/mod_imagemap.html
+
+Installing
+----------
+
+The installable ZIP extension can be downloaded from the ["Save as image
+map" extension page on inkscape.org][4]. You can also create the ZIP from
+this source code by running `make`.
+
+[4]: https://inkscape.org/~viatrix/%E2%98%85save-as-image-map
+
+Contributing
+------------
+
+One should know how to use Git. The canonical URL for this repository is
+<https://git.viatrix.computer/inx.imagemap>. Send patches or pull requests
+to <inx.imagemap@git.viatrix.computer>.
+
+### Contributing code
+
+When you change code, run the tests to confirm everything still works. See
+the [inkex unit test documentation][5]. You will likely need to set the
+`INKSCAPE_COMMAND` and `PYTHONPATH` environment variables.
+
+If you add any translatable strings, you can run `make pot` to regenerate
+the `imagemap.pot` file.
+
+[5]: https://inkscape.gitlab.io/extensions/documentation/authors/unit-tests
+
+### Contributing translations
+
+Use the `imagemap.pot` file as a template for translation. Translations go
+in `imagemap.po` files in subdirectories of the `locale/` folder. The
+subdirectories are titled after [gettext locale names][6].
+
+[6]: https://www.gnu.org/software/gettext/manual/html_node/Locale-Names