forks/archivebox
1
0
Fork 0
Code Releases Activity

better dev instructions in readme

Browse source
This commit is contained in:
Nick Sweeting 2020-12-12 01:50:16 +02:00
parent d9e76752b7
commit 327308573a
1 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -435,22 +435,18 @@ All contributions to ArchiveBox are welcomed! Check our [issues](https://github.
First, install the system dependencies from the "Bare Metal" section above. First, install the system dependencies from the "Bare Metal" section above.
Then you can clone the ArchiveBox repo and install Then you can clone the ArchiveBox repo and install
```python3 ```python3
git clone https://github.com/ArchiveBox/ArchiveBox git clone https://github.com/ArchiveBox/ArchiveBox && cd ArchiveBox
cd ArchiveBox
git checkout master # or the branch you want to test git checkout master # or the branch you want to test
git pull git pull --recurse-submodules
git submodule init
git submodule update
# Install ArchiveBox + python dependencies # Install ArchiveBox + python dependencies
python3 -m venv .venv && source .venv/bin/activate && pip install -e .[dev] python3 -m venv .venv && source .venv/bin/activate && pip install -e .[dev]
# or # or with pipenv: pipenv install --dev && pipenv shell
pipenv install --dev && pipenv shell
# Install node dependencies # Install node dependencies
npm install npm install
# Optional: install the extractor dependencies # Optional: install extractor dependencies manually or with helper script
./bin/setup.sh ./bin/setup.sh
# Optional: develop via docker by mounting the code dir into the container # Optional: develop via docker by mounting the code dir into the container
@ -490,6 +486,8 @@ You can also run all these in Docker. For more examples see the Github Actions C
# or individually: # or individually:
./bin/build_docs.sh ./bin/build_docs.sh
./bin/build_pip.sh ./bin/build_pip.sh
./bin/build_deb.sh
./bin/build_brew.sh
./bin/build_docker.sh ./bin/build_docker.sh
``` ```