Skip to content

Update installation documentation #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update installation documentation #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,26 @@ Windows users need a Python installation and C++ compiler:
```bash
cd spdx-online-tools
pip install -r requirements.txt
```
4. Run Django migrate.

4. Create Github API configuration according to [GitHub Developer Sensitive Data](#github-developer-sensitive-data).
Copy link
Collaborator

@techytushar techytushar Oct 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please include the correct link

Copy link
Contributor Author

@nezhar nezhar Oct 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm actually linking to a section that is already available in the readme. This format works in my editor and should also work on GitHub: https://til.hashrocket.com/posts/3d5f989178-link-to-headers-in-github-readmes

Would you the full link, such as https://github.com/spdx/spdx-online-tools#github-developer-sensitive-data ?


5. Run Django migrate.

```bash
cd src
python manage.py migrate
```
5. (Optional) If you want use xml-editor with licenses/exceptions from [spdx license list](https://github.com/spdx/license-list-data/), download the license name database.
6. (Optional) If you want use xml-editor with licenses/exceptions from [spdx license list](https://github.com/spdx/license-list-data/), download the license name database.
```bash
python src/populate.py
```
6. Start the application.
7. Start the application.
```bash
python manage.py runserver
```
7. Open `localhost:8000/` in the browser.
8. Open `localhost:8000/` in the browser.

8. Register and login to use the tools.
9. Register and login to use the tools.

## How to Run Tests

Expand Down