1 files changed, 59 insertions, 0 deletions
diff --git a/shelr/README.md b/shelr/README.md
new file mode 100644
index 0000000..707b057
--- /dev/null
+++ b/shelr/README.md
@@ -0,0 +1,59 @@
+Quick shelr howto
+=================
+
+This is how to make automatic recordings without the hassle to type yourself (and fail and start over again).
+
+
+Before recording
+----------------
+
+* use zsh and _not_ bash, cause zsh+ohmyzsh autosets the window title to the running command 
+* put DISABLE_CORRECTION="true" in .zshrc  (otherwise zsh might ask you for correction where it is not needed)
+* turn off fancy shell prompts
+* i use a custom "demo" user for recordings, with a clean .zshrc (see above) 
+
+Setup shelr to use the ttyrec backend
+-------------------------------------
+
+I realized that the bad timing i encountered earlier was due the default shelr backend "script".
+I changed it to "ttyrec" and now the timing is ok.
+please try above shelr play cmd again with updated recording.
+see [upload to shelr is currently broken](https://github.com/shelr/shelr/issues/21) 
+
+
+Record
+------
+
+    sudo apt-get install ttyrec
+    shelr backend ttyrec
+
+    sudo su - demo
+
+    rm -rf ~/leap/demo/example.org
+    rm -rf ~/leap/demo/leap_cli
+    rm -rf ~/leap/demo/leap_platform
+ 
+    shelr record   # you don't need a fancy title, will get overridden for upload. only to keep track your recordings 
+
+
+* in another termial start: 
+
+
+     ./shelr-screencast.sh setup/setup.sh
+
+
+Upload
+======
+
+* before uploading, edit "meta" and change following keys:
+
+     `cd /home/demo/.local/share/shelr/RECORD_ID
+     sed -i 's/`hostname`/demobox/g' meta
+     sed -i 's/title.*/title" : "Leap Platform Demo - https:\/\/leap.se",/' meta`
+
+* uploading sucks. you will always get an 500 error, but sometimes the vid yet shows up on http://shelr.tv. 
+  i couldn't login using github oauth, if anyone have an openid account, please try.
+
+
+     shelr push RECORD_ID
+