Make README less confusing
This commit is contained in:
parent
969b7f68fb
commit
fba686a73c
54
README.md
54
README.md
@ -1,56 +1,27 @@
|
|||||||
# voicegardens
|
# voicegardens
|
||||||
|
|
||||||
> https://voicegardens.org
|
> An online landscape, built as a tool to explore the many aspects of the human voice.
|
||||||
>
|
|
||||||
> http://doesitsparkjoy.voicegardens.org
|
|
||||||
|
|
||||||
## @ Interwebz
|
## Interwebz
|
||||||
|
|
||||||
* [barbican.org.uk: This is Public Space](https://www.barbican.org.uk/whats-on/2019/event/this-is-public-space)
|
- [live site voicegardens.org](https://voicegardens.org)
|
||||||
* [upprojects.com: This is Public Space](https://www.upprojects.com/projects/this-is-public-space/)
|
- [test site doesitsparkjoy.voicegardens.org](http://doesitsparkjoy.voicegardens.org)
|
||||||
|
- [barbican.org.uk: This is Public Space](https://www.barbican.org.uk/whats-on/2019/event/this-is-public-space)
|
||||||
## Meanwhile, in the padiverse
|
- [upprojects.com: This is Public Space](https://www.upprojects.com/projects/this-is-public-space/)
|
||||||
|
|
||||||
* [kari.this.is.public.space](https://pad.vvvvvvaria.org/kari.this.is.public.space) (private)
|
|
||||||
* [vocoder](https://pad.vvvvvvaria.org/vocoder) (public)
|
|
||||||
|
|
||||||
## Doodle Doodle Doo
|
|
||||||
|
|
||||||
* [wet-signal-voice-garden.pdf](./media/wet-signal-voice-garden.pdf)
|
|
||||||
* [staringcaring.com](http://staringcaring.com/)
|
|
||||||
|
|
||||||
## Hackity Hack Hack
|
## Hackity Hack Hack
|
||||||
|
|
||||||
Please note, these commands were run on a Debian Stretch system.
|
|
||||||
|
|
||||||
### Install packed lunch
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ sudo apt install -y make git
|
$ sudo apt install -y make git
|
||||||
```
|
|
||||||
|
|
||||||
### Get your discount source code
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ git clone ssh://gitea@vvvvvvaria.org:12345/varia/voicegardens.git
|
$ git clone ssh://gitea@vvvvvvaria.org:12345/varia/voicegardens.git
|
||||||
$ cd voicegardens
|
$ cd voicegardens
|
||||||
```
|
|
||||||
|
|
||||||
### Do the Python dance
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ python3 -m venv .venv
|
$ python3 -m venv .venv
|
||||||
$ source .venv/bin/activate
|
$ source .venv/bin/activate
|
||||||
$ pip install -r requirements.txt
|
$ pip install -r requirements.txt
|
||||||
```
|
|
||||||
|
|
||||||
### Run the server
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ make dev-serve
|
$ make dev-serve
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy the site
|
## Deploying
|
||||||
|
|
||||||
You can add the following to your SSH configuration:
|
You can add the following to your SSH configuration:
|
||||||
|
|
||||||
@ -74,14 +45,15 @@ $ sudo -i # you have root access too
|
|||||||
Then it's possible to release the site with the following targets.
|
Then it's possible to release the site with the following targets.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ make doesitsparkjoy # https://doesitsparkjoy.voicegardens.org
|
$ make doesitsparkjoy # https://doesitsparkjoy.voicegardens.org
|
||||||
|
$ make voicegardens # https://voicegardens.org
|
||||||
```
|
```
|
||||||
|
|
||||||
### Layers of the Onion
|
## Layers of the Onion
|
||||||
|
|
||||||
* [Flask](http://flask.palletsprojects.com/en/1.1.x/)
|
- [Flask](http://flask.palletsprojects.com/en/1.1.x/)
|
||||||
* [p5.js](https://p5js.org)
|
- [p5.js](https://p5js.org)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
TBD.
|
- [AGPL](LICENSE.txt)
|
||||||
|
Loading…
Reference in New Issue
Block a user