diff options
| author | SoniEx2 <endermoneymod@gmail.com> | 2020-02-16 21:20:23 -0300 |
|---|---|---|
| committer | SoniEx2 <endermoneymod@gmail.com> | 2020-02-16 21:20:23 -0300 |
| commit | f2b77e7f73b443cbbbada16d9ce6fa28233ddd22 (patch) | |
| tree | f634e813f264240dcf4cf742fb27f93fda9006c3 | |
| parent | 1b26ad799217af7e187fdae78e862a6bf46e5591 (diff) | |
Add quick README
Adds README detailing install instructions and how to access language reference.
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
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 <repo>#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 |