asciinema.org/README.md

49 lines
1.1 KiB
Markdown
Raw Normal View History

2012-03-06 18:35:26 +00:00
# ascii.io [![Build Status](https://secure.travis-ci.org/sickill/ascii.io.png?branch=master)](http://travis-ci.org/sickill/ascii.io)
2012-04-03 10:03:31 +00:00
2012-04-09 11:44:38 +00:00
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.
2012-05-06 00:02:36 +00:00
## Installation
### Requirements
2012-04-09 11:44:38 +00:00
ascii.io site is a Ruby on Rails application. You should have following
installed:
2012-05-06 00:02:36 +00:00
* ruby 1.9.2+
2012-04-09 11:44:38 +00:00
* 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)
2012-05-06 00:02:36 +00:00
### Get the source code
2012-04-09 11:44:38 +00:00
$ git clone git://github.com/sickill/ascii.io.git
$ cd ascii.io
2012-05-06 00:02:36 +00:00
### Prepare DB config
Copy *config/database.yml.example* to *config/database.yml* and set adapter to
what you prefer.
2012-04-09 11:44:38 +00:00
2012-05-06 00:02:36 +00:00
### Setup the app
2012-04-09 11:44:38 +00:00
2012-05-06 00:02:36 +00:00
$ ./script/setup
2012-04-09 11:44:38 +00:00
2012-05-06 00:02:36 +00:00
This will install gem dependencies and setup database.
2012-04-09 11:44:38 +00:00
2012-05-06 00:02:36 +00:00
## Run
2012-04-09 11:44:38 +00:00
2012-07-29 17:47:34 +00:00
$ ./script/rails s
2012-04-09 11:44:38 +00:00
## Authors
* Marcin Kulik (sickill)
* Michał Wróbel (sparrovv)