shelr/README.md

   1 Quick shelr howto
   2 =================
   3
   4 This is how to make automatic recordings without the hassle to type yourself (and fail and start over again).
   5
   6
   7 Before recording
   8 ----------------
   9
  10 * use zsh and _not_ bash, cause zsh+ohmyzsh autosets the window title to the running command
  11 * put DISABLE_CORRECTION="true" in .zshrc  (otherwise zsh might ask you for correction where it is not needed)
  12 * turn off fancy shell prompts
  13 * i use a custom "demo" user for recordings, with a clean .zshrc (see above)
  14
  15 Setup shelr to use the ttyrec backend
  16 -------------------------------------
  17
  18 I realized that the bad timing i encountered earlier was due the default shelr backend "script".
  19 I changed it to "ttyrec" and now the timing is ok.
  20 please try above shelr play cmd again with updated recording.
  21 see [upload to shelr is currently broken](https://github.com/shelr/shelr/issues/21)
  22
  23
  24 Record
  25 ------
  26
  27     sudo apt-get install ttyrec
  28     shelr backend ttyrec
  29
  30     sudo su - demo
  31
  32     rm -rf ~/leap/demo/example.org
  33     rm -rf ~/leap/demo/leap_cli
  34     rm -rf ~/leap/demo/leap_platform
  35
  36     shelr record   # you don't need a fancy title, will get overridden for upload. only to keep track your recordings
  37
  38
  39 * in another termial start:
  40
  41
  42      ./shelr-screencast.sh setup/setup.sh
  43
  44
  45 Upload
  46 ======
  47
  48 * before uploading, edit "meta" and change following keys:
  49
  50      `cd /home/demo/.local/share/shelr/RECORD_ID
  51      sed -i 's/`hostname`/demobox/g' meta
  52      sed -i 's/title.*/title" : "Leap Platform Demo - https:\/\/leap.se",/' meta`
  53
  54 * uploading sucks. you will always get an 500 error, but sometimes the vid yet shows up on http://shelr.tv.
  55   i couldn't login using github oauth, if anyone have an openid account, please try.
  56
  57
  58      shelr push RECORD_ID
  59