diff options
| author | Frederick Muriuki Muriithi | 2024-11-19 16:51:04 -0600 |
|---|---|---|
| committer | Frederick Muriuki Muriithi | 2024-11-21 11:46:27 -0600 |
| commit | 95f1e142d2c3d52a7a9174a75c6ee855dbc8a917 (patch) | |
| tree | c4def1f701801bee26b086d5a7165b7fa9bff5d8 /README.md | |
| parent | 2791a60afe5206dcef74a1e264237d10e59d7bca (diff) | |
| download | gn-libs-95f1e142d2c3d52a7a9174a75c6ee855dbc8a917.tar.gz | |
Initialise build for the project.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5983ba3 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# gn-libs: GeneNetwork Libraries + +This is a collection of tools/utilities that find use in more than one +GeneNetwork project. + +## Installing + +* TODO: Document this + +## Developing + +### Code Checks: Linting and Typing + +Run linter +```sh +pylint $(find gn_libs -name '*.py') +``` + +Run mypy +```sh +mypy --show-error-codes . +``` + +### Running Tests + +* TODO: Document this |