Browse Source

Merge branch 'master' of https://git0.fmf.uni-lj.si/studen/nixSuite

Andrej 3 years ago
parent
commit
f38a11f9cb
1 changed files with 22 additions and 0 deletions
  1. 22 0
      README.md

+ 22 - 0
README.md

@@ -0,0 +1,22 @@
+# NIX Suite
+
+A set of tools used to format NIX compatible databases. 
+
+### Installation
+
+#### Linux
+
+```bash
+git clone https://git0.fmf.uni-lj.si/studen/nixSuite.git
+```
+
+#### Windows
+
+Install git for [Windows][gitWindows], recommended to use Git Bash. Use commands for linux (cd, mkdir, etc.) and follow Linux installation instructions.
+
+### Jupyter
+
+Look for example of a jupyter notebook that allows dynamic modification of a database [here][jupyterSample].
+
+[jupyterSample]: https://git0.fmf.uni-lj.si/studen/nixSuite/src/master/pythonScripts/updateFields.ipynb
+[gitWindows]: https://gitforwindows.org/