From b72bf75ddd523e80ae05319a943026b2d85709b3 Mon Sep 17 00:00:00 2001 From: Alvie Rahman Date: Fri, 18 Jan 2019 18:03:13 +0000 Subject: [PATCH] Add readme --- macros => pymacro/macros | 0 pymacro => pymacro/pymacro | 0 {tests => pymacro/tests}/macros | 0 {tests => pymacro/tests}/test_actual_output | 0 {tests => pymacro/tests}/test_expected_output | 0 {tests => pymacro/tests}/test_input | 0 {tests => pymacro/tests}/test_macros_biology | 0 .../tests}/test_macros_custom_plurals | 0 {tests => pymacro/tests}/test_macros_plural | 0 word_utils.py => pymacro/word_utils.py | 0 readme.md | 19 +++++++++++++++++++ 11 files changed, 19 insertions(+) rename macros => pymacro/macros (100%) rename pymacro => pymacro/pymacro (100%) rename {tests => pymacro/tests}/macros (100%) rename {tests => pymacro/tests}/test_actual_output (100%) rename {tests => pymacro/tests}/test_expected_output (100%) rename {tests => pymacro/tests}/test_input (100%) rename {tests => pymacro/tests}/test_macros_biology (100%) rename {tests => pymacro/tests}/test_macros_custom_plurals (100%) rename {tests => pymacro/tests}/test_macros_plural (100%) rename word_utils.py => pymacro/word_utils.py (100%) create mode 100644 readme.md diff --git a/macros b/pymacro/macros similarity index 100% rename from macros rename to pymacro/macros diff --git a/pymacro b/pymacro/pymacro similarity index 100% rename from pymacro rename to pymacro/pymacro diff --git a/tests/macros b/pymacro/tests/macros similarity index 100% rename from tests/macros rename to pymacro/tests/macros diff --git a/tests/test_actual_output b/pymacro/tests/test_actual_output similarity index 100% rename from tests/test_actual_output rename to pymacro/tests/test_actual_output diff --git a/tests/test_expected_output b/pymacro/tests/test_expected_output similarity index 100% rename from tests/test_expected_output rename to pymacro/tests/test_expected_output diff --git a/tests/test_input b/pymacro/tests/test_input similarity index 100% rename from tests/test_input rename to pymacro/tests/test_input diff --git a/tests/test_macros_biology b/pymacro/tests/test_macros_biology similarity index 100% rename from tests/test_macros_biology rename to pymacro/tests/test_macros_biology diff --git a/tests/test_macros_custom_plurals b/pymacro/tests/test_macros_custom_plurals similarity index 100% rename from tests/test_macros_custom_plurals rename to pymacro/tests/test_macros_custom_plurals diff --git a/tests/test_macros_plural b/pymacro/tests/test_macros_plural similarity index 100% rename from tests/test_macros_plural rename to pymacro/tests/test_macros_plural diff --git a/word_utils.py b/pymacro/word_utils.py similarity index 100% rename from word_utils.py rename to pymacro/word_utils.py diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..5d03de1 --- /dev/null +++ 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)