dnutiu/benchmark-scoreboard
dnutiu/benchmark-scoreboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updating README page

Browse source
This commit is contained in:
Denis-Cosmin Nutiu 2017-04-15 23:59:36 +03:00
parent 7b7bd5f4e3
commit cca91366b9
1 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -7,29 +7,39 @@ for some benchmarking data which is gathered from another application.
## Installing ## Installing
To install and run the application, you must do the following:
First, rename the config.lock.py to config.py First, rename the config.lock.py to config.py
and update the file to match your configuration settings. and update the file to match your configuration settings.
Then run: Then run:
``` ```bash
python3 setup.py install python3 setup.py install
nohup python3 application.py & nohup python3 application.py &
``` ```
#####Running Tests
In the root directory, run the following command:
```bash
python -m unittest
```
## Posting data ## Posting data
For now, you can post data using curl. You can post data using curl. There are no restrictions on whoever can post data.
``` ```bash
curl -H "Content-Type: application/json" -X POST -d '{"gpu":"GPU DUMMY TEXT","cpu":"CPU DUMMY TEXT","log":"DETAILED LOG","score": 1}' http://localhost:5000/upload curl -H "Content-Type: application/json" -X POST -d '{"gpu":"GPU DUMMY TEXT","cpu":"CPU DUMMY TEXT","log":"DETAILED LOG","score": 1}' http://localhost:5000/upload
``` ```
## Milestones: ## Milestones:
1. Make simple view which displays benchmarks. [Done 13 Apr 2017] 1. Make simple view which displays benchmarks. [Done 13 Apr 2017]
* Improve design * Improve design [Done]
* Add about us page * Add about us page [?]
* Try to use a mysql database * Try to use a mysql database
2. Add user registration 2. Add user registration
3. Perfect 3. Perfect