aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2018-06-28 02:43:42 +0200
committerTeddy Wing2018-06-28 02:43:42 +0200
commitb39ace1adedf3515a3f84f4ea93a5c1bcf511624 (patch)
tree2e6451f9b3e3ba3249d8a6d566da12ee0942b255
parent18dd50d6680bfe17160a75f53c90c1e52aeabe69 (diff)
downloadglyphs-typarichive-b39ace1adedf3515a3f84f4ea93a5c1bcf511624.tar.bz2
Add README
Describe what the script does. Include rough installation instructions and license information.
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3f541b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+TypArichive
+===========
+
+A [Glyphs][1] script that creates an archive of the current font. It:
+
+1. Copies the current font to a new timestamped file
+2. Moves the original file to an `_archive` directory
+3. Opens the new font file
+4. Updates a timestamp in the font family name
+
+
+## Install
+Download [typarichive.py][2] and put it in the `~/Library/Application
+Support/Glyphs/Scripts` directory.
+
+In Glyphs, hold the Option key and select the _Script > Reload Scripts_ menu
+item.
+
+
+## License
+Copyright © 2018 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).
+
+
+[1]: https://glyphsapp.com/
+[2]: https://github.com/teddywing/typarichive/raw/master/typarichive.py