aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorrhenium <re4k@re4k.info>2013-05-11 15:58:57 +0900
committerrhenium <re4k@re4k.info>2013-05-11 15:58:57 +0900
commit86d799076664950c84045785604b0e7f4d3ccfe3 (patch)
tree0e9bea756af657abd8a8907219fda3624c0ec6ae /README.md
parentf91fe6cc0e1b6d05cb6dd5568c82498cec9a569b (diff)
downloadaclog-86d799076664950c84045785604b0e7f4d3ccfe3.tar.gz
update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 43 insertions, 15 deletions
diff --git a/README.md b/README.md
index 705373f..b33a503 100644
--- a/README.md
+++ b/README.md
@@ -28,34 +28,62 @@ A web service like Favstar.
## Setup
### MySQL
-Add to `my.cnf`
+* Add to `my.cnf`
- [mysqld]
- innodb_file_format = Barracuda
- innodb_file_per_table = 1
- innodb_large_prefix
+```ini
+[mysqld]
+innodb_file_format = Barracuda
+innodb_file_per_table = 1
+innodb_large_prefix
+```
+
+* Create MySQL user
-Create MySQL user
### aclog configuration (application)
+* Install packages
+
+ $ bundle install
+
* Set consumer keys, base URL, ..
- cp config/settings.yml.example config/settings.yml
- vi config/settings.yml
+ $ cp config/settings.yml.example config/settings.yml
+ $ vi config/settings.yml
* Setup database
- cp config/database.yml.example config/database.yml
- vi config/database.yml
- rake db:setup
+ $ cp config/database.yml.example config/database.yml
+ $ vi config/database.yml
+ $ rake db:setup
* Set secret token
- cp config/initializers/secret_token.rb.example config/initializers/secret_token.rb
- sed -i s/replace_here/$(rake secret)/g config/initializers/secret_token.rb
+ $ cp config/initializers/secret_token.rb.example config/initializers/secret_token.rb
+ $ sed -i s/replace_here/$(rake secret)/g config/initializers/secret_token.rb
+
+* Start
+
+ $ ./start.sh start
### aclog configuration (worker)
+* In collector/ ..
+* Install packages
+
+ $ bundle install
+
* Set consumer keys, secret key
- cp collector/settings.yml.example collector/settings.yml
- vi collector/settings.yml
+ $ cp settings.yml.example collector/settings.yml
+ $ vi settings.yml
+
+* Start
+
+ $ RAILS_ENV=production ./start.sh
+
+
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request