Skip to content

Commit

Permalink
Update docs with module changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ppfeister committed May 17, 2024
1 parent 63a1c14 commit ea1c421
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
5 changes: 0 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,15 +133,10 @@ Original Creator - [Siddharth Dushantha](https://github.com/sdushantha)

[docs_install]: /docs/install.md
[docs_docker]: /docs/install.md#docker
[docs_docker_dockerhub]: /docs/install.md#docker
[docs_docker_compose]: /docs/install.md#using-compose
[docs_docker_source]: /docs/install.md#build-image-from-source-useful-for-contributors
[docs_py]: /docs/install.md#python
[docs_py_build]: /docs/install.md#build-python-package-from-source-useful-for-contributors
[docs_contrib]: /docs/CONTRIBUTING.md
[docs_contrib_adding_targets]: /docs/CONTRIBUTING.md#adding-targets
[docs_contrib_removing_targets]: /docs/CONTRIBUTING.md#removing-targets
[docs_contrib_restoring_targets]: /docs/CONTRIBUTING.md#restoring-targets
[ext_pypi]: https://pypi.org/project/sherlock-project/
[ext_brew]: https://formulae.brew.sh/formula/sherlock

19 changes: 14 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,22 @@ Python
pipx install sherlock-project
```

### Build python package from source (useful for contributors)
### Build live package from source (useful for contributors)

Building an editable (or live) package links the entry point to your current directory, rather than to the standard install location. This is often useful when working with the code base, as changes are reflected immediately without reinstallation.

```bash
# pipx is recommended, but pip may suffice if pipx is unavailable
git clone https://github.com/sherlock-project/sherlock.git
cd sherlock
pipx install .
# Assumes repository cloned, and pwd is repository root
pipx install -e .
```

### Run package from source (no install)

If you'd rather not install directly to your system, you can import the module at runtime with `-m`.

```bash
# Assumes repository cloned, and pwd is repository root
python3 -m sherlock user123 user789
```

<h2>
Expand Down

0 comments on commit ea1c421

Please sign in to comment.