Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
Will-Cooper committed May 25, 2021
1 parent d68fc06 commit 8a175a1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
All contributors are very welcome to fork (button top right of page) the repo
to make edits to the website code, in which case:
```bash
git clone --recurse-submodules https://github.com/<your-github-username>/SIMPLE-web.git
git clone https://github.com/<your-github-username>/SIMPLE-web.git
cd SIMPLE-web
git remote add origin https://github.com/<your-github-username>/SIMPLE-web.git
git remote add upstream https://github.com/SIMPLE-AstroDB/SIMPLE-web.git
Expand All @@ -12,7 +12,7 @@ The last line is to verify the remote is set up correctly, you can then push to
(we advise using branches to easily isolate different changes you may be making) and pull from the upstream repo.
You can then create online a pull request to merge your repo into the upsteam repo after review.
```bash
git pull --recurse-submodules upsteam main
git pull upstream main
git add <files you have changed>
git commit -m "A good, informative commit message"
git push origin main # or instead of main, a different branch
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ interactive as possible.
To run the application locally, clone the application repo and move into it with:

```bash
git clone --recurse-submodules https://github.com/SIMPLE-AstroDB/SIMPLE-web.git
git clone https://github.com/SIMPLE-AstroDB/SIMPLE-web.git
cd SIMPLE-web
```

Expand Down Expand Up @@ -41,7 +41,7 @@ If you have changed either the host or port with system arguments, use those ins
We also recommend keeping up to date with the repo changes, and most importantly,
the [astrodbkit2](https://github.com/dr-rodriguez/AstrodbKit2) package:
```bash
git pull --recurse-submodules upstream main
git pull
pip install git+https://github.com/dr-rodriguez/AstrodbKit2
```
You can also get the latest copy of the SQLite database binary file with:
Expand Down

0 comments on commit 8a175a1

Please sign in to comment.