diff --git a/README.md b/README.md index 92859c9..5eaa637 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ in the src directory which is a validation file; it contains the accepted parameter names, types, and limits for configurable options in the application which is built on app_skellington. The format is multi-level .ini syntax. -Reference the ConfigObj documentation for config.ini and config.spec +Reference the ConfigObj documentation for config.ini and config.spec format. See: - https://configobj.readthedocs.io/en/latest/configobj.html#the-config-file-format @@ -31,15 +31,15 @@ file always contains the full specification of parameters; i.e. even default parameters are added into the config file. Linux: - + /home/\/.config/\/config.ini - + /home/\/.cache/\/log/\.log Windows: - + C:\\Users\\\\\\\\Local\\\\\config.ini - + C:\\Users\\\\\\\\Local\\\\\Logs\\\.log Application configuration can be overridden ad-hoc through the --config @@ -61,6 +61,28 @@ Tests ----- Tests are a WIP. Recommendation is to run 'pytest' in the 'tests' directory. +Development +----------- +Clone the repo: +```commandline +git clone https://git-mirror.zavage.net/zavage-software/app_skellington.git +``` + +Verify your desired python environment. + +Poetry install to install dependencies and the program in your desired python environment +```commandline +poetry install +# verify no errors +``` + +Install pre-commit hooks: +```commandline +pre-commit install +``` + +Begin development. + License ------- I'm releasing this software under one of the most permissive @@ -72,4 +94,3 @@ Notes ----- See official website: https://zavage-software.com Please report bugs, improvements, or feedback! -