JOJ/Joint-Teapot
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: very simple doc

Browse Source
This commit is contained in:
张泊明518370910136 2021-10-13 02:58:50 +08:00
parent 1d93ff7226
commit ba88605f8e
No known key found for this signature in database
GPG Key ID: FBEF5DE8B9F4C629
2 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -7,15 +7,15 @@ A handy tool for TAs in JI to handle works through [Gitea](https://focs.ji.sjtu.
### Setup venv (Optional)
```bash
python3 -m venv env
source env/Scripts/activate
python3 -m venv env # you only need to do that once
source env/Scripts/activate # each time when you need this venv
```
### Install & Run
### Install
```bash
pip3 install -e .
vi .env # configure environment
cp .env.exmaple .env && vi .env # configure environment
joint-teapot --help
```

29
docs/index.md
View File

@ -1,3 +1,28 @@
# Welcome
# Joint Teapot
In progress...
A handy tool for TAs in JI to handle works through [Gitea](https://focs.ji.sjtu.edu.cn/git/), [Canvas](https://umjicanvas.com/), and [JOJ](https://joj.sjtu.edu.cn/). Joint is related to JI and also this tool which join websites together. Teapot means to hold Gitea, inspired by [@nichujie](https://github.com/nichujie).
## Getting Started
### Setup venv (Optional)
```bash
python3 -m venv env # you only need to do that once
source env/Scripts/activate # each time when you need this venv
```
### Install
```bash
pip3 install -e .
cp .env.exmaple .env && vi .env # configure environment
joint-teapot --help
```
### For developers
```bash
pip3 install -r requirements-dev.txt
pre-commit install
pytest -svv
```