From 7b8aed8a5f91fbee75188085956143e95596712a Mon Sep 17 00:00:00 2001 From: Paul Pfeister Date: Sun, 9 Jun 2024 22:22:10 -0400 Subject: [PATCH] Update docs --- docs/INSTALL.md | 9 +++++++++ docs/README.md | 5 ++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index d00be91..2bab798 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -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). diff --git a/docs/README.md b/docs/README.md index 1c3ae0c..2ef832f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -30,8 +30,11 @@ | | 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, BlackArch, Testing, Sid | +| Homebrew | `brew install sherlock` | | + +PyPI and DockerHub images are mainaintenced by the Sherlock Project. Others are community supported. ### Alternative guides and methods