Skip to content

Commit

Permalink
fix readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
oceans404 committed Jun 6, 2024
1 parent d7291b3 commit 1cce2a6
Showing 1 changed file with 42 additions and 40 deletions.
82 changes: 42 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,76 +11,78 @@ The [`bootstrap-local-environment.sh`](./bootstrap-local-environment.sh) file us
- [Install `pidof`](https://command-not-found.com/pidof)
- [Install `grep`](https://command-not-found.com/grep)

1. Install the specific version of nillion with flags to also download nada and the python client at the same specific version by running
### Setup

```bash
nilup install {version} --nada-dsl --python-client
```
1. Install the specific version of nillion with flags to also download nada and the python client at the same specific version by running

This results in a message that shows you the downloaded paths to the versions of nada_dsl and the python client you’ll need to use, for example if I was downloading a version `vABCD`, I would see:
```bash
nilup install {version} --nada-dsl --python-client
```

```bash
Using pip to install /Users/steph/.nilup/sdks/vABCD/nada_dsl-0.1.0-py3-none-any.whl
nada_dsl version vABCD installed
Installing python client version vABCD
Downloading vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl to /Users/steph/.nilup/sdks/vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl
Using pip to install /Users/steph/.nilup/sdks/vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl
python client version vABCD installed
```
This results in a message that shows you the downloaded paths to the versions of nada_dsl and the python client you’ll need to use, for example if I was downloading a version `vABCD`, I would see:

```bash
Using pip to install /Users/steph/.nilup/sdks/vABCD/nada_dsl-0.1.0-py3-none-any.whl
nada_dsl version vABCD installed
Installing python client version vABCD
Downloading vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl to /Users/steph/.nilup/sdks/vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl
Using pip to install /Users/steph/.nilup/sdks/vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl
python client version vABCD installed
```

Use this message to figure out your local paths to the latest experimental versions of
Use this message to figure out your local paths to the latest experimental versions of

- python client path: `/Users/steph/.nilup/sdks/vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl`
- nada path: `/Users/steph/.nilup/sdks/vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl`
- python client path: `/Users/steph/.nilup/sdks/vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl`
- nada path: `/Users/steph/.nilup/sdks/vABCD/py_nillion_client-0.1.1-cp37-abi3-macosx_11_0_arm64.whl`

2. Set nillion version
2. Set nillion version

```bash
nilup use {version}
```

3. Change directories into this branch of this repo

```
cd nillion-python-starter
git branch payments-flow-update
git checkout payments-flow-update
git pull origin payments-flow-update
```
```
cd nillion-python-starter
git branch payments-flow-update
git checkout payments-flow-update
git pull origin payments-flow-update
```

4. Create venv

```bash
bash ./create_venv.sh && source .venv/bin/activate
```
```bash
bash ./create_venv.sh && source .venv/bin/activate
```

5. Manually install nada using the path printed by nilup installation in step 1

```bash
python3 -m pip install {your/nada/path}
```
```bash
python3 -m pip install {your/nada/path}
```

6. Manually install the Python client using the path printed by nilup installation in step 1

```bash
python3 -m pip install {your/python/client/path}
```
```bash
python3 -m pip install {your/python/client/path}
```

7. Bootstrap local environment to connect to the nillion-devnet and add the configuration to your .env file

```bash
./bootstrap-local-environment.sh
```
```bash
./bootstrap-local-environment.sh
```

8. Compile all programs

Nada programs need to be compiled ahead of being stored. Compile all programs in the [programs](./programs/) folder with the script [`compile_programs.sh`](./compile_programs.sh):
Nada programs need to be compiled ahead of being stored. Compile all programs in the [programs](./programs/) folder with the script [`compile_programs.sh`](./compile_programs.sh):

```shell
bash compile_programs.sh
```
```shell
bash compile_programs.sh
```

This generates a `programs-compiled` folder containing the compiled programs.
This generates a `programs-compiled` folder containing the compiled programs.

## Usage

Expand Down

0 comments on commit 1cce2a6

Please sign in to comment.