Merge pull request #28 from archesproject/robgaston-cleans-up-readme

cleans up README.md

README.md

@@ -3,17 +3,17 @@
 ## Setup
 ### Note: This is a guide to set up the project for local development.
 
-1. Download the arches_lingo:
+1. Download the arches-lingo repo:
 
-    a.  If using the [Github CLI](https://cli.github.com/): `gh repo clone archesproject/arches_lingo`
+    a.  If using the [Github CLI](https://cli.github.com/): `gh repo clone archesproject/arches-lingo`
 
-    b.  If not using the Github CLI: `git clone https://github.com/archesproject/arches_lingo.git`
+    b.  If not using the Github CLI: `git clone https://github.com/archesproject/arches-lingo.git`
 
-2. Download the arches-rdm package:
+2. Download the arches package:
 
-    a.  If using the [Github CLI](https://cli.github.com/): `gh repo clone archesproject/arches-rdm`
+    a.  If using the [Github CLI](https://cli.github.com/): `gh repo clone archesproject/arches`
 
-    b.  If not using the Github CLI: `git clone https://github.com/archesproject/arches-rdm.git`
+    b.  If not using the Github CLI: `git clone https://github.com/archesproject/arches.git`
 
 3. Create a virtual environment outside of both repositories: 
     ```
@@ -27,13 +27,13 @@
 
 5. Navigate to the arches-rdm package, and install it into the virtual environment:
     ```
-    cd arches-rdm
+    cd arches
     pip install -e .
     ```
 
 6. Navigate to the arches_lingo, and install the python requirements:
     ```
-    cd ../arches_lingo
+    cd ../arches-lingo
     pip install -r arches_lingo/install/requirements.txt
     ```
 
@@ -51,7 +51,7 @@
 
 10. Navigate to your project then install the frontend dependencies.
     ```
-    cd arches_lingo/
+    cd arches-lingo/
     npm install
     ```
 
@@ -66,7 +66,7 @@
 13. Navigate to the arches_lingo top-level directory, and install the ontologies, branches, and resource models from the arches-rdm package.
     ```
     python manage.py setup_db
-    python manage.py packages -o load_package -s ../arches-rdm/arches_rdm/pkg --yes -db
+    python manage.py packages -o load_package -s arches_lingo/pkg --yes -db
     ```
 
 14. In the terminal window that is running the Django server, halt the server and restart it.
@@ -81,7 +81,7 @@ NOTE: Changes are commited to the arches-rdm repository.
 
 1. Navigate to the repository
     ```
-    cd arches-rdm
+    cd arches-lingo
     ```
 
 2. Cut a new git branch
@@ -93,7 +93,7 @@ NOTE: Changes are commited to the arches-rdm repository.
 
     1. Manually export the model or branch from the project
 
-    2. Manually move the exported model or branch into one of the subdirectories in the `arches-rdm/arches_rdm/pkg/graphs` directory.
+    2. Manually move the exported model or branch into one of the subdirectories in the `arches-lingo/arches_lingo/pkg/graphs` directory.
 
 4. Add your changes to the current git commit
     ```
@@ -107,4 +107,4 @@ NOTE: Changes are commited to the arches-rdm repository.
     git push origin HEAD
     ```
 
-6. Navigate to https://github.com/archesproject/arches-rdm/pulls to see and commit the pull request
+6. Navigate to https://github.com/archesproject/arches-lingo/pulls to see and commit the pull request