Skip to content

Commit

Permalink
Merge pull request #2160 from sherlock-project/feature/better-docu
Browse files Browse the repository at this point in the history
Update install docs
  • Loading branch information
sdushantha committed Jun 17, 2024
2 parents 7443de1 + 4e1e237 commit 923fa4c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
9 changes: 9 additions & 0 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ pipx install sherlock-project

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

> [!Note]
> With the switch to Poetry, Sherlock no longer requires a `requirements.txt` file. Dependencies are now specified within the `pyproject.toml` file.
>
> If the legacy `requirements.txt` file is still desired, it can be dynamically generated:
> ```bash
> # Append `--with dev` or `--only dev` to include dev dependencies
> poetry export --without-hashes -f requirements.txt --output requirements.txt
> ```
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.

Note that the version number will be 0.0.0 for pipx local builds unless manually changed in the pyproject file (it will prompt the user for an update).
Expand Down
6 changes: 5 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,12 @@
| | Command | Notes |
| - | - | - |
| PyPI | `pipx install sherlock-project` | `pip` may be used in place of `pipx` |
| Homebrew | `brew install sherlock` | Community supported |
| Docker | `docker pull sherlock/sherlock` | |
| Debian family | `apt install sherlock` | Kali, Parrot, Debian Testing and Sid |
| BlackArch | `pacman -S sherlock` | |
| Homebrew | `brew install sherlock` | |

PyPI and DockerHub images are mainaintenced by the Sherlock Project. Others are community supported.

### Alternative guides and methods

Expand Down

0 comments on commit 923fa4c

Please sign in to comment.