From f2b77e7f73b443cbbbada16d9ce6fa28233ddd22 Mon Sep 17 00:00:00 2001 From: SoniEx2 Date: Sun, 16 Feb 2020 21:20:23 -0300 Subject: Add quick README Adds README detailing install instructions and how to access language reference. --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9009c4f --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +A Boneless Datastructure Language +================================= + +Installing +---------- + +1. Pick a repo: [web+ganarchy:0f74bd87a23b515b45da7e6f5d9cc82380443dab](web+ganarchy:0f74bd87a23b515b45da7e6f5d9cc82380443dab). +2. `pip install -e #egg=gan0f74bd87a23b515b45da7e6f5d9cc82380443dab` +3. `import abdl` +4. Use `gan0f74bd87a23b515b45da7e6f5d9cc82380443dab` as the dependency in `setup.py` or equivalent. + +Usage +----- + +TODO + +Language Reference +------------------ + +See module level documentation: + +``` +>>> import abdl +>>> help(abdl) +``` + +License +------- + +ABDL is AGPL-3.0-or-later. See LICENSE.txt -- cgit 1.4.1