Add readme

2024-10-22 14:51:54 +00:00 · 2019-01-18 18:03:13 +00:00 · 2019-01-18 18:03:13 +00:00 · b72bf75ddd
commit b72bf75ddd
parent 5e56ea491e
11 changed files with 19 additions and 0 deletions
--- a/pymacro/macros
+++ b/pymacro/macros
--- a/pymacro/pymacro
+++ b/pymacro/pymacro
--- a/pymacro/tests/macros
+++ b/pymacro/tests/macros
--- a/pymacro/tests/test_actual_output
+++ b/pymacro/tests/test_actual_output
--- a/pymacro/tests/test_expected_output
+++ b/pymacro/tests/test_expected_output
--- a/pymacro/tests/test_input
+++ b/pymacro/tests/test_input
--- a/pymacro/tests/test_macros_biology
+++ b/pymacro/tests/test_macros_biology
--- a/pymacro/tests/test_macros_custom_plurals
+++ b/pymacro/tests/test_macros_custom_plurals
--- a/pymacro/tests/test_macros_plural
+++ b/pymacro/tests/test_macros_plural
--- a/pymacro/word_utils.py
+++ b/pymacro/word_utils.py
--- a/readme.md
+++ b/readme.md
@ -0,0 +1,19 @@
+# macros
+
+A syntax/specification for defining macros in any sort of text file.
+The goal of this is to be minimal but intuitive and with enough features to make
+it worth using. It doesn't come with any features that you won't be using really
+regularly. 
+
+The idea is to avoid having to type long words over and over again without
+overly relying on pronouns if it would make the writing less clear.
+
+## features 
+
+- [automatic plurals (can also be manually changed on a word by word basis)](syntax.md#plurals)
+- [intuitive capitalization](syntax.md#capitalization)
+- [sourcing macros from external files](syntax.md#external-definitions)
+
+## syntax
+
+The syntax can be found [here](syntax.md)