Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
altendky authored Apr 6, 2021
1 parent 65797c0 commit 34000cf
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,14 +175,16 @@ Installation for Linux:

1. Plotman assumes that a functioning [Chia](https://github.com/Chia-Network/chia-blockchain)
installation is present on the system. Activate your `chia` environment by typing
`. /path/to/your/chia/install/activate`.
`source /path/to/your/chia/install/activate`.
2. Then, install Plotman using the following command:

pip install git+https://github.com/ericaltendorf/plotman.git@development

3. That's it! You can now run Plotman by typing `plotman version` to verify its version.
pip install git+https://github.com/ericaltendorf/plotman@development
3. Plotman will look for `config.yaml` in your current working directory when you run it.
You can find [an example configuration file](./config.yaml) in the project source that can be used
as a starting point.
5. That's it! You can now run Plotman by typing `plotman version` to verify its version.
Run `plotman --help` to learn about the available commands.

### Development note:

If you are forking Plotman, simply replace the installation step with `pip install .[dev]` from the project root directory to install *your* version of plotman with test and development extras.
If you are forking Plotman, simply replace the installation step with `pip install --editable .[dev]` from the project root directory to install *your* version of plotman with test and development extras.

0 comments on commit 34000cf

Please sign in to comment.