Update README

speleo3 · Dec 16, 2023 · f6f96d1 · f6f96d1
1 parent 9051776
commit f6f96d1
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 7 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+[![CI](https://github.com/speleo3/inkscape-speleo/workflows/CI/badge.svg)](https://github.com/speleo3/inkscape-speleo/actions)
+
+# Inkscape extensions for cave surveying
+
+## Installation
+
+Copy everything from the [extensions](extensions) folder into the Inkscape extensions folder. This is probably similar to one of these:
+
+* Windows: `%APPDATA%\Inkscape\extensions`
+* Linux: `~/.config/inkscape/extensions`
+
+If you can't find the folder, check _Inkscape > Preferences > System > User config_, or run `inkscape --user-data-directory`.
+
+## See also:
+
+* http://therion.speleo.sk/
+* http://survex.com/
+* http://jaskinie.jaszczur.org/index_en.html