[readme] rebuild TOC

README.md

@@ -8,17 +8,21 @@
 ![Coverage Status](./docs/coverage-badge.svg)
 
 <!--toc:start-->
-
+- [Teilchensammler: Collect parts in a list](#teilchensammler-collect-parts-in-a-list)
-- [Development](#development)
+  - [Badges](#badges)
-  - [Getting started](#getting-started)
+  - [Development](#development)
-    - [Python](#python)
+    - [Getting started](#getting-started)
-    - [PostgreSQL](#postgresql)
+      - [Python](#python)
-    - [Get the code](#get-the-code)
+      - [PostgreSQL](#postgresql)
-  - [Making changes](#making-changes)
+      - [Get the code](#get-the-code)
-  - [Using the App](#using-the-app)
+    - [Making changes](#making-changes)
-- [Dependency management](#dependency-management)
+    - [Using the App](#using-the-app)
-  - [Installing dependencies](#installing-dependencies)
+  - [Dependency management](#dependency-management)
-
+    - [Installing dependencies](#installing-dependencies)
+  - [More on tools that are used](#more-on-tools-that-are-used)
+    - [Direnv (automatic venv)](#direnv-automatic-venv)
+      - [Subshells or Shells started from Editors](#subshells-or-shells-started-from-editors)
+    - [just](#just)
 <!--toc:end-->
 
 ## Development
@@ -46,9 +50,11 @@ installed by [homebrew]).
 
 #### PostgreSQL
 
-Set up PostgreSQL, a role and a schema. I have it on localhost, using the
+Set up PostgreSQL, a role and a schema.
-project name for role and schema name, and password. See `.env.test` for
+
-providing connection information.
+I have it on localhost, using the project name for role and schema name, and
+password. Using a VM, docker or even a remote instance is possible: See
+`.env.test` for providing connection information.
 
 #### Get the code
 
@@ -62,19 +68,20 @@ don't have just).
 ### Making changes
 
 Change code, settings, templates, dependencies as you see fit. Run `just lint`
-repeatedly. Don't forget migrations. Commit often.
+repeatedly. Don't forget migrations. Commit often. Please add tests.
 
 ### Using the App
 
 `just serve` and open
-[localhost:8000/collector](http://localhost:8000/collector/) in your browser.
+[localhost:8000/](http://localhost:8000/collector/) in your browser. Start
+entering Teile.
 
 ## Dependency management
 
 This project uses [pip-compile-multi] for hard-pinning dependencies versions.
 Please see its documentation for usage instructions. In short,
-`requirements/base.in` contains the list of direct requirements with occasional
+`requirements/prod.in` contains the list of direct requirements with occasional
-version constraints (like `Django<2`) and `requirements/base.txt` is
+version constraints (like `Django<2`) and `requirements/prod.txt` is
 automatically generated from it by adding recursive tree of dependencies with
 fixed versions. The same goes for `test` and `dev`.
 
@@ -102,6 +109,33 @@ testing requirements and development tools.
 A useful command is `pip-sync requirements/dev.txt`, it uninstalls packages
 from your virtualenv that aren't explicitly specified as dependencies.
 
+## More on tools that are used
+
+These are not strictly necessary but very convenient.
+
+### Direnv (automatic venv)
+
+When direnv is [integrated into the shell](https://direnv.net/docs/hook.html)
+entering the project directory for the first time will cause direnv to create a
+hidden directory for the virtual environment.
+
+It will also activate that existing virtualenv automatically upon entering the
+project directory.
+
+#### Subshells or Shells started from Editors
+
+If your editor spawns a shell window or new terminal, it might be necessary to
+`direnv reload` before running any commands. This will make sure direnv has
+things set up. neovim's terminal requires this.
+
+### just
+
+[just] is used as a task runner. Think "makefile" but less confusing. (make is
+a build tool and task runner and much more, just intends to be a task runner.)
+
+If you don't want to install just, you can still look at its `justfile` to see
+how test runners, linters, dev servers and such are to be executed.
+
 ----
 
 [pip-compile-multi]: https://pypi.org/project/pip-compile-multi/