Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Pfed-prog committed Sep 22, 2022
1 parent 38b0c0c commit 5d109d8
Showing 1 changed file with 2 additions and 26 deletions.
28 changes: 2 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,35 +40,11 @@ Liquidity Shares and Voting Shares can only be released after the creator of the
## Requirements

1. [Vscode](https://code.visualstudio.com/) or another IDE
2. [Python3.10](https://www.python.org/downloads/)
2. [Python 3](https://www.python.org/downloads/)
3. [PIP Package Manager](https://pip.pypa.io/en/stable/)
4. [Py-algorand-sdk](https://py-algorand-sdk.readthedocs.io/en/latest/index.html)
5. [PyTEAL](https://pyteal.readthedocs.io/en/stable/installation.html)
6. Algorand [Purestake node](https://developer.purestake.io/)

## Background

PyTeal is a python library for generating TEAL programs. PyTeal is used for writing smart contracts on the Algorand blockchain.
To interact with the smart contract the Python SDK will be used to compile and deploy the PyTeal smart contract code.

# Project Setup

We setup Python virtual environment. The following commands will install and activate the virtual environment and then install dependencies.

## Installing with Virtual environment

```bash
pip install virtualenv
virtualenv venv
source venv/bin/activate
pip install pyteal
```

![https://imgur.com/pgG6fin.png](https://imgur.com/pgG6fin.png)

`deactivate` to deactivate the virtual environment.

`source venv/bin/activate` to activate virtualenv once again. Replace bin with Scripts on Windows.
6. Algorand [Purestake node api key](https://developer.purestake.io/)

# PyTeal AMM Smart Contract

Expand Down

0 comments on commit 5d109d8

Please sign in to comment.