diff --git a/README.md b/README.md index 951782c..cfd0f6d 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,14 @@ ![build-status](https://drone.runcible.io/api/badges/androiddrew/htmx_contact/status.svg) -Learning HTMX by building a the htmx contact.app +Learning [HTMX](https://htmx.org/) by building a the htmx contact.app from https://hypermedia.systems/book/contents/ -## First time setup +## Local Development -Create a virtual environment and activate it. Now from the root project directory run `./scripts/bootstrap`. This will install `pip-tools` and sync any dependencies for the first time. +This project uses Pyinvoke for local development utilities. See: -## Dependency management +``` +inv --list +``` -Dependencies are managed via [pip-tools]. - -### Adding a dependency - -To add a dependency, edit `requirements.in` (or `dev-requirements.in` -for dev dependencies) and add your dependency then run `pip-compile -requirements.in`. - -### Syncing dependencies - -Run `pip-sync requirements.txt dev_requirements.txt`. - -## Testing - -Run the tests by invoking `py.test` in the project root. Make sure you -run any pending migrations beforehand. +For a list of current utilities.