Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shumo Chu committed Feb 10, 2020
1 parent 9c57e4c commit a382846
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ PyTeal **hasn't been security audited**. Use it at your own risk.

pyteal requires python version >= 3.6

* `pip3 install -r requirements.txt`
* `pip3 install pyteal`

### Run Demo

Expand Down
7 changes: 4 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ Install PyTeal

The easiest way of installing PyTeal is using :code:`pip` : ::

pip install pyteal
$ pip3 install pyteal

You can also install from source:
Alternatively, choose a `distribution file <https://pypi.org/project/pyteal/#files>`_, and run ::

$ pip3 install [file name]

TODO: instructions for install from source


2 changes: 1 addition & 1 deletion docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Below is the example of writing *Hashed Time Locked Contract* in Pyteal::


As shown in this exmaple, the logic of smart contract is expressed using PyTeal expressions constructed in Python. PyTeal overloads Python's arithmetic operators
such as :code:`<` and :code:`==` (more overloaded operators can be found in TODO), allowing Python developers express smart contract logic more naturally.
such as :code:`<` and :code:`==` (more overloaded operators can be found in :ref:`arithmetic_expressions`), allowing Python developers express smart contract logic more naturally.

Last, :code:`teal()` is called to convert an PyTeal expression
to a TEAL program, consisting a sequence of TEAL opcodes.
Expand Down

0 comments on commit a382846

Please sign in to comment.