X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=README.md;h=50a36c8c3ebfc3f64a0e5f3d68879afed97f9cf0;hb=2af219c661ec227fdf5dc28ddeb1110e29e60d2e;hp=cad778fe5282e409b6cf96c67d9f13c154effa3e;hpb=709d889f1f3749dde25e74493038bd28f8ce5ca4;p=crypto-install.git diff --git a/README.md b/README.md index cad778f..50a36c8 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,17 @@ Until I set up a better routine: Simply copy the built file into your path and possibly ensure execution permissions. + +# DEVELOPMENT + +There is a `Makefile` available to run common commands, e.g.: + + make # checks PEP8, runs tests, builds final file + make run # run the built program + make clean # remove build folder + +If you have [`git-hooks`](https://github.com/icefox/git-hooks) +installed, then the two hooks in `git_hooks` will run the tests and +check for PEP8 compatibility before committing as well. Run +`git hooks --install` in the checked out folder to register the hooks +initially.