Fix spelling and grammar
- [Docs](#docs)
- [License](#license)
- [Tests](#tests)
-- [Donatitons](#donations)
+- [Donations](#donations)
## Overview
The `neo-boa` compiler is a tool for compiling Python files to the `.avm` format for usage in the [Neo Virtual Machine](https://github.com/neo-project/neo-vm/) which is used to execute contracts on the [Neo Blockchain](https://github.com/neo-project/neo/).
-The compiler supports a subset of the Python language ( in the same way that a _boa contstrictor_ is a subset of the Python snake species)
+The compiler supports a subset of the Python language ( in the same way that a _boa constrictor_ is a subset of the Python snake species)
#### What does it currently do
@@ -52,22 +52,22 @@ pip install neo-boa
#### Manual
-Clone the repository and navigate into the project directory. Make a Python 3 virtual environment and activate
-it via
+Clone the repository and navigate into the project directory. Make a Python 3 virtual environment and activate it via:
```
python3 -m venv venv
source venv/bin/activate
```
-or to install Python 3.5 specifically
+or, to install Python 3.5 specifically:
```
virtualenv -p /usr/local/bin/python3.5 venv
source venv/bin/activate
```
-Then install requirements
+Then, install the requirements:
+
```
pip install -r requirements.txt
```
@@ -76,7 +76,7 @@ pip install -r requirements.txt
## Usage
-The compiler may be used like the following
+The compiler may be used like in the following example:
```
from boa.compiler import Compiler
@@ -84,15 +84,17 @@ from boa.compiler import Compiler
Compiler.load_and_save('path/to/your/file.py')
```
+
## Docs
-You can [read the docs here](http://neo-boa.readthedocs.io/en/latest/)
+You can [read the docs here](http://neo-boa.readthedocs.io/en/latest/).
## Tests
Tests are important.
+
## License
- Open-source [MIT](https://github.com/CityOfZion/neo-python/blob/master/LICENSE.md).
