Skip to content
This repository was archived by the owner on Jan 10, 2021. It is now read-only.

Commit 02bb015

Browse files
authored
Merge pull request #55 from Slugbotics/wtpisaac/even-more-repo-fixes
README tweaks
2 parents 1c6b82a + 86cbef9 commit 02bb015

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,21 @@
22
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
33
[![Platform: py4web](https://img.shields.io/badge/platform-py4web-informational.svg)](https://github.com/web2py/py4web)
44

5-
A modern, simple issue tracker for teams. App for the py4web framework.
5+
A modern, simple issue tracker for teams. Currently in the prototype stage. App for the py4web framework.
66

77
# Installation Instructions
8-
Sluggo uses a mostly standard py4web environment as defined by the conda environment for py4web in CSE183, including
9-
the packages added partway through the quarter (click & watchgod).
10-
However, some additional prerequisites are required.
8+
Begin by installing py4web, the server which powers Sluggo. py4web and relating installation instructions can be found
9+
here: https://github.com/web2py/py4web
1110

12-
In addition to the standard environment, Sluggo relies on libraries specified in our requirements.txt file:
11+
In addition to py4web, Sluggo relies on libraries specified in our requirements.txt file:
1312

1413
`pip install -r requirements.txt`
1514

1615
You should then have all necessary prerequisites to run Sluggo.
1716

1817
## How to Use
19-
You can find thorough documentation on how to use Sluggo in USAGE.md. This is recommended for
20-
graders to read through before giving our application a try.
18+
You can find thorough documentation on how to use Sluggo in USAGE.md. This will render
19+
in the application under the Help page.
2120

2221
## Attribution
2322
You can find attribution for third party libraries in ATTRIBUTION.md

0 commit comments

Comments
 (0)