Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
smartgoo committed Nov 12, 2023
1 parent 36224c9 commit 9cf9cc9
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,15 @@ The additional crate `x-kaspadbr` is where all code specific to this project can
# Development Process:
Should you wish to develop this locally, here is the process.

All code for this project is currently located in the `x-kaspadbr` crate.

**First**, clone this project.

**Second**, build and install the Python package in local virtual env:
**Second**, develop as needed. All code for this project is currently located in the `x-kaspadbr` crate.

**Third**, use Maturin Develop to build and install the Python package in local virtual env for testing purposes.
1. `cd ./rusty-kaspa/x-kaspadbr`
2. `python -m venv env`
3. `source env/bin/activate`
4. `pip install maturin`
2. `source env/bin/activate` (create venv first if necessary: `python -m venv env`, activate, and `pip install maturin`)
5. `maturin develop --release` to build and install in the active Python venv.

**Third**, test the built Python package from within the same venv. Refer to code in `./x-kaspadbr/python/`.
7. Test the built Python package from within the same venv. Refer to code in `./x-kaspadbr/python/`.

# Install in a local Python venv
1. `cd ./rusty-kaspa/x-kaspadbr`
Expand Down

0 comments on commit 9cf9cc9

Please sign in to comment.