aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authornea <romangraef@gmail.com>2022-10-05 01:54:45 +0200
committernea <romangraef@gmail.com>2022-10-05 01:54:45 +0200
commitfd22b8f3743c7216e2fefa265214b3315cd60bf4 (patch)
tree641d5e62dbd0372b14e0d0aac35465b4effc0e2d /README.md
parentd9296584270f1e902944fc7390d0b43c34aa2dbb (diff)
downloadsbdata-fd22b8f3743c7216e2fefa265214b3315cd60bf4.tar.gz
sbdata-fd22b8f3743c7216e2fefa265214b3315cd60bf4.tar.bz2
sbdata-fd22b8f3743c7216e2fefa265214b3315cd60bf4.zip
Make stuff more palatable
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index fce8e37..8de277b 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,10 @@
Hi, jani, i will automate your job, and, when you are jobless, poor and homeless, i will take you in from the streets, feed you, put you in a little cage and pet you, because you have done an amazing job so far.
+
+
+## Setup
+
+ - Make sure the NEU repo is set up. When in doubt you can always use `git submodule update --init` to redownload it
+ - Set up your pipenv with `pipenv install`
+ - Run either `pipenv run python -m sbdata -explore` or `pipenv run python -m sbdata -json` in the main directory.