Skip to content

Commit a76af14

Browse files
committed
Update README.md
1 parent 2abf4d8 commit a76af14

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,20 @@
1111
[![Issue Stats](http://issuestats.com/github/NETponents/ParseBasic/badge/issue?style=flat)](http://issuestats.com/github/NETponents/ParseBasic)
1212
[![Gratipay](https://img.shields.io/gratipay/ARMmaster17.svg)](http://gratipay.com/~ARMmaster17)
1313

14-
Interpreter for developing ParseBasic code.
14+
## What is it?
15+
ParseBasic is an interpreter for running simulations for Octoduino programs. ParseBasic is modeled after Basic (hence the name). The goal of ParseBasic is to create a virtualized framework upon which you can create parsers for the Octoduino project.
16+
17+
## Installing
18+
There are two ways to install ParseBasic, depending on your environment.
19+
20+
**WARNING: NOT SUPPORTED YET**
21+
22+
The easiest way, for development machines, is to use pip. Simply just type in 'python pip install parsebasic'.
23+
24+
The other way, which we reccommend for CI environments, is to use GitHub releases. Simply cURL the target release to your directory, unzip/untar the archive, then run 'python ./pb.py'.
25+
26+
## How can I learn ParseBasic?
27+
Take a look at the documentation. We will have code examples coming soon in another release.
28+
29+
## Contributing
30+
The easiest way to contribute is to leave a tip using Gratipay. Just click the *tips* badge above. If you know Python, you can also leave a code contribution. Just ask us if you see an issue you like and we can assign it to you. Then just fork the project to your own GitHub account and begin work. When you are done, open a PR and a project collaborator will get back to ASAP.

0 commit comments

Comments
 (0)