Create inital project structure + lexer

Signed-off-by: Johnny Richard <johnny@johnnyrichard.com>

1 files changed, 48 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..e194377
--- /dev/null
+++ b/README
@@ -0,0 +1,48 @@
+PIPAC
+=====
+
+The pipalang compiler.
+
+https://pipalang.github.io
+
+This project is licensed under GPLv3, read more on COPYRIGHT doc.
+
+For instructions on how to build and run the compiler, read the HACKING
+document.  Please don't use this project in production, it's still under
+development.
+
+CONTRIBUTING
+------------
+
+### CODE
+
+This project uses mailing lists as main medium of communication. All mail
+archives can be found at https://sr.ht/~johnnyrichard/pipalang/lists.
+
+If you want to contribute to the source code, send plain text patch to:
+
+    ~johnnyrichard/pipalang-devel@lists.sr.ht
+
+Please use git-sendmail to send the patches.  You might want to configure your
+git to prevent silly mistakes:
+
+    $ git config sendmail.to "~johnnyrichard/pipalang-devel@lists.sr.ht"
+    $ git config format.subjectPrefix "PATCH pipac"
+
+### ANNOUNCES
+
+If you want to follow important announces like new releases subscribe to:
+
+    ~johnnyrichard/pipalang-discuss@lists.sr.ht.
+
+### DICUSSIONS
+
+For discussions about the language subscribe to:
+
+    ~johnnyrichard/pipalang-discuss@lists.sr.ht
+
+### IRC
+
+If you want to keep in contact with the community, feel free to join our
+channel #pipalang on LiberaChat IRC.
+