Merge pull request #9 from nexB/update-readme

Add setup steps in README.rst
aboutcode-org · Nov 12, 2022 · b3fb68f · b3fb68f
2 parents 9213335 + ab75277
commit b3fb68f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/minecode/README.rst b/minecode/README.rst
@@ -2,3 +2,11 @@ minecode
 =========
 
 MineCode is a Django web app that visits upstream package repositories and saves the package metadata to the PackageDB.
+
+Local setup
+===========
+
+* ./configure
+* make postgres
+* make envfile
+* make run
diff --git a/packagedb/README.rst b/packagedb/README.rst
@@ -2,3 +2,11 @@ packagedb
 =========
 
 PackageDB is a Django web app that provides the model for storing package metadata.
+
+Local setup
+===========
+
+* ./configure
+* make postgres
+* make envfile
+* make run