You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
asciinema.org/README.md

49 lines
1.1 KiB
Markdown

# ascii.io [![Build Status](https://secure.travis-ci.org/sickill/ascii.io.png?branch=master)](http://travis-ci.org/sickill/ascii.io)
12 years ago
12 years ago
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.
12 years ago
## Installation
### Requirements
12 years ago
ascii.io site is a Ruby on Rails application. You should have following
installed:
12 years ago
* ruby 1.9.2+
12 years ago
* 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)
12 years ago
### Get the source code
12 years ago
$ git clone git://github.com/sickill/ascii.io.git
$ cd ascii.io
12 years ago
### Prepare DB config
Copy *config/database.yml.example* to *config/database.yml* and set adapter to
what you prefer.
12 years ago
12 years ago
### Setup the app
12 years ago
12 years ago
$ ./script/setup
12 years ago
12 years ago
This will install gem dependencies and setup database.
12 years ago
12 years ago
## Run
12 years ago
12 years ago
$ ./script/rails s
12 years ago
## Authors
* Marcin Kulik (sickill)
* Michał Wróbel (sparrovv)