add readme
This commit is contained in:
23
README.md
23
README.md
@@ -1 +1,22 @@
|
||||
# Back-end
|
||||
# Websockets server
|
||||
|
||||
## Quick start
|
||||
|
||||
This project uses [GNU make](https://www.gnu.org/software/make/) to build and run. When available, type `make` and hit enter to see what is available:
|
||||
|
||||
```
|
||||
➜ make
|
||||
Targets:
|
||||
venv - Create virtualenv in .venv
|
||||
install - Install deps and this package
|
||||
run - Run the server via 'python -m medtrace_synth'
|
||||
install-dev - Install deps (and this package) in dev mode
|
||||
dev - Run using PYTHONPATH=src (no install)
|
||||
build - Build sdist and wheel into dist/
|
||||
clean - Remove build artifacts
|
||||
nuke - Clean artifacts and remove .venv
|
||||
```
|
||||
|
||||
Try `make run` to download all dependencies and run the server.
|
||||
|
||||
> Note that running `make dev` will start the server and watch the `src` directory, but you also will need to have the `pojagi-dsp` project locally, and the `POJAGI_DSP_PATH` environment variable exported to point to the top level of that project's directory.
|
||||
|
||||
Reference in New Issue
Block a user