asciinema.org/README.md
Marcin Kulik 0e0a148cb9 Words
2012-05-06 02:02:36 +02:00

1.2 KiB

ascii.io Build Status

This is the source code of ascii.io website/player. If you look for ascii.io command line recorder go here: https://github.com/sickill/ascii.io-cli

Below are setup instructions in case you want to contribute and/or play with it on your local machine.

Installation

Requirements

ascii.io site is a Ruby on Rails application. You should have following installed:

  • ruby 1.9.2+
  • bundler (gem install bundler)

For thumbnail generation you need also:

  • tmux
  • scriptreplay (Linux only via script package. OSX users: sorry, your script command is crippled anyway)

Get the source code

$ git clone git://github.com/sickill/ascii.io.git
$ cd ascii.io

Prepare DB config

Copy config/database.yml.example to config/database.yml and set adapter to what you prefer.

Setup the app

$ ./script/setup

This will install gem dependencies and setup database.

Run

  • start webserver with script/rails s
  • (optional) start background job worker for thumbnail generation with bundle exec sidekiq

Authors

  • Marcin Kulik (sickill)
  • Michał Wróbel (sparrovv)