Mercurial > hg > chourdakisreiss2018smc
changeset 10:fff6981fecd1
added readme instructions
| author | Emmanouil Theofanis Chourdakis <e.t.chourdakis@qmul.ac.uk> |
|---|---|
| date | Sat, 01 Dec 2018 16:09:34 +0000 |
| parents | 30648126316b |
| children | cd2fa632df41 |
| files | README.md |
| diffstat | 1 files changed, 21 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/README.md Sat Dec 01 15:44:05 2018 +0000 +++ b/README.md Sat Dec 01 16:09:34 2018 +0000 @@ -1,13 +1,31 @@ # How to Use - The demo is provided as a Dockerfile. ## Requirements - 1. (Docker)[https://docs.docker.com/get-started/] 2. A Linux host. System tried is: `Linux 4.19.4-arch1-1-ARCH #1 SMP PREEMPT Fri Nov 23 09:06:58 UTC 2018 x86_64 GNU/Linux` with LSB `1.4` 1. **Note**: Due to a recent issue, the following line must be run before trying to build the container: `echo N | sudo tee /sys/module/overlay/parameters/metacopy` ## Installation +1. Clone this repo: `hg clone https://code.soundsoftware.ac.uk/hg/chourdakisreiss2018smc` +2. Change directory to new folder: `cd chourdakisreiss2018smc` +3. Run the following to download voices: `bash download_voices.sh` +4. Build the container: `docker build -t radioplay-gen .` -1. Clone this repo: `hg clone https://code.soundsoftware.ac.uk/hg/chourdakisreiss2018smc` +## Example usage +1. Run the docker container: `bash run_docker.sh` +2. Run the VNC client of your choice and connect to `localhost:5900`: [connect using vnc](images/img3.png) +3. When connected, right click somewhere on the ubuntu wallpaper logo and select `0. Setup brat`: [setup brat](images/img4.png) + 1. Enter `au1` for both username and password, you can leave the e-mail part empty +4. Right click again and select `1. Semantic Analysis`: + 1. Write your story, save and close the text editor. Press enter at the opened terminal window. + 2. Choose to overwrite (Y) the stories. (Don't select N at this point) + 3. Annotate with (brat)[https://brat.nlplab.org/introduction.html] so that you have from something like: [non-annotated](images/img1.png) to: [annotated](images/img2.png) + 1. ** Warning ** There is a current issue with upstream brat that gives an error when annotating. Until it's fixed annotation won't work. + 4. Keep pressing enter (change the files using libreoffice if you like) +5. Right click again and select `2. Radioplay render` + 1. Leave libreoffice files as is, you can change them later. + 2. A chrome browser will pop up. **LEAVE IT OPEN!** it will close by itself. + 3. You will listen to the short story. +6. If you want to browse the directory, right click again and choose `X. Browse folder` +7. Press `ctrl+c` on the terminal you started the docker to quit.