aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
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