Skip to content

Commit 923fa4c

Browse files
authored
Merge pull request #2160 from sherlock-project/feature/better-docu
Update install docs
2 parents 7443de1 + 4e1e237 commit 923fa4c

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/INSTALL.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@ pipx install sherlock-project
3939

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

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

docs/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,12 @@
3030
| | Command | Notes |
3131
| - | - | - |
3232
| PyPI | `pipx install sherlock-project` | `pip` may be used in place of `pipx` |
33-
| Homebrew | `brew install sherlock` | Community supported |
3433
| Docker | `docker pull sherlock/sherlock` | |
34+
| Debian family | `apt install sherlock` | Kali, Parrot, Debian Testing and Sid |
35+
| BlackArch | `pacman -S sherlock` | |
36+
| Homebrew | `brew install sherlock` | |
37+
38+
PyPI and DockerHub images are mainaintenced by the Sherlock Project. Others are community supported.
3539

3640
### Alternative guides and methods
3741

0 commit comments

Comments
 (0)