From fba686a73cd37b8d29309f17bf54535fc4954188 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Tue, 11 Feb 2020 16:37:24 +0100 Subject: [PATCH] Make README less confusing --- README.md | 54 +++++++++++++----------------------------------------- 1 file changed, 13 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index cd603ca..2e60080 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,27 @@ # voicegardens -> https://voicegardens.org -> -> http://doesitsparkjoy.voicegardens.org +> An online landscape, built as a tool to explore the many aspects of the human voice. -## @ Interwebz +## Interwebz -* [barbican.org.uk: This is Public Space](https://www.barbican.org.uk/whats-on/2019/event/this-is-public-space) -* [upprojects.com: This is Public Space](https://www.upprojects.com/projects/this-is-public-space/) - -## Meanwhile, in the padiverse - -* [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/) +- [live site voicegardens.org](https://voicegardens.org) +- [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) +- [upprojects.com: This is Public Space](https://www.upprojects.com/projects/this-is-public-space/) ## Hackity Hack Hack -Please note, these commands were run on a Debian Stretch system. - -### Install packed lunch - ```bash $ sudo apt install -y make git -``` - -### Get your discount source code - -```bash $ git clone ssh://gitea@vvvvvvaria.org:12345/varia/voicegardens.git $ cd voicegardens -``` - -### Do the Python dance - -```bash $ python3 -m venv .venv $ source .venv/bin/activate $ pip install -r requirements.txt -``` - -### Run the server - -```bash $ make dev-serve ``` -### Deploy the site +## Deploying 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. ```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/) -* [p5.js](https://p5js.org) +- [Flask](http://flask.palletsprojects.com/en/1.1.x/) +- [p5.js](https://p5js.org) ## License -TBD. +- [AGPL](LICENSE.txt)