From 87970a254f41e597afdea1d0373302bfddd367e0 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Thu, 8 Apr 2021 06:03:46 -0400 Subject: [PATCH] Update README.md --- README.md | 41 ++++++++--------------------------------- 1 file changed, 8 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index fbf1489b..85c4d52a 100644 --- a/README.md +++ b/README.md @@ -616,12 +616,9 @@ All contributions to ArchiveBox are welcomed! Check our [issues](https://github. Low hanging fruit / easy first tickets:
Total alerts -
- - ### Setup the dev environment - +
Click to expand... #### 1. Clone the main code repo (making sure to pull the submodules as well) @@ -672,13 +669,9 @@ docker run -it -p 8000:8000 \ See the `./bin/` folder and read the source of the bash scripts within. You can also run all these in Docker. For more examples see the Github Actions CI/CD tests that are run: `.github/workflows/*.yaml`. - -
- - #### Run in DEBUG mode - +
Click to expand... ```bash archivebox config --set DEBUG=True @@ -688,12 +681,9 @@ archivebox server --debug ...
-
- - #### Build and run a Github branch - +
Click to expand... ```bash docker build -t archivebox:dev https://github.com/ArchiveBox/ArchiveBox.git#dev @@ -702,12 +692,9 @@ docker run -it -v $PWD:/data archivebox:dev ...
-
- - #### Run the linters - +
Click to expand... ```bash ./bin/lint.sh @@ -716,12 +703,9 @@ docker run -it -v $PWD:/data archivebox:dev ...
-
- - #### Run the integration tests - +
Click to expand... ```bash ./bin/test.sh @@ -730,12 +714,9 @@ docker run -it -v $PWD:/data archivebox:dev ...
-
- - #### Make migrations or enter a django shell - +
Click to expand... Make sure to run this whenever you change things in `models.py`. ```bash @@ -750,12 +731,9 @@ archivebox manage dbshell
-
- - #### Build the docs, pip package, and docker image - +
Click to expand... (Normally CI takes care of this, but these scripts can be run to do it manually) ```bash @@ -771,12 +749,9 @@ archivebox manage dbshell
-
- - #### Roll a release - +
Click to expand... (Normally CI takes care of this, but these scripts can be run to do it manually) ```bash