just human things (#7)
Expand README.md, add CONTRIBUTING.md, rename LICENSE to standard name
This commit is contained in:
parent
3e8b5809a0
commit
7c25d052d2
|
@ -0,0 +1,36 @@
|
|||
# Contributing
|
||||
|
||||
## Dependencies
|
||||
- Python >=3.9
|
||||
- [Poetry](https://python-poetry.org/docs/master/#installing-with-the-official-installer)
|
||||
|
||||
## Setup
|
||||
* Install Python dependencies with poetry
|
||||
```shell
|
||||
poetry install
|
||||
```
|
||||
|
||||
- Set up the database
|
||||
```shell
|
||||
poetry run python manage.py migrate
|
||||
```
|
||||
|
||||
- Start the API server
|
||||
```shell
|
||||
poetry run python manage.py runserver
|
||||
```
|
||||
|
||||
### Updating the database
|
||||
|
||||
If you modify any database models (`models.py`), you'll need to run the following to update the database:
|
||||
```shell
|
||||
poetry run python manage.py makemigrations
|
||||
poetry run python manage.py migrate
|
||||
```
|
||||
|
||||
### Linting
|
||||
|
||||
```shell
|
||||
poetry run mypy
|
||||
poetry run black .
|
||||
```
|
|
@ -1,3 +1,11 @@
|
|||
# Frogress
|
||||
|
||||
An API for storing/retrieving decompilation progress
|
||||
|
||||
## Development
|
||||
For those interested in contributing to frogress's development, please see [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
## Usage
|
||||
The API will be hosted at https://progress.deco.mp. Usage guide coming soon.
|
||||
|
||||
TODO: add example curl commands as well as code snippets / CSV parser for existing format
|
Loading…
Reference in New Issue