summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjomo <github@jomo.tv>2016-01-17 23:16:37 +0100
committerjomo <github@jomo.tv>2016-01-17 23:16:37 +0100
commit69c0037cf6510b1dbb7717dff6ceab2884c9073b (patch)
tree0e269c8820c713d45d183caa15cc498206be10cb
parente53228eaf15dc2d9ab5f631e312ef5132eaae747 (diff)
add README
-rw-r--r--README.md23
-rw-r--r--README.rdoc2
2 files changed, 23 insertions, 2 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b9180ae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# redstoner.com
+
+Redstoner's ruby-on-rails website with blog, forum, etc.
+
+# Installation
+
+You need a MySQL server with `utf8mb4` support.
+If you have issues, try adding this to your `my.cnf`:
+```
+[mysqld]
+character-set-client-handshake = FALSE
+character-set-server = utf8mb4
+collation-server = utf8mb4_unicode_ci
+```
+
+The rest should be a default rails installation:
+```shell
+bundle
+rake db:setup
+rails s
+```
+
+Note: We currently use rails [4-2-stable](https://github.com/rails/rails/tree/4-2-stable) because it has backported [support for `utf8mb4`](https://github.com/rails/rails/commit/37e5770fd3db04f3206075d736fc14161dd04530). \ No newline at end of file
diff --git a/README.rdoc b/README.rdoc
deleted file mode 100644
index 1524f99..0000000
--- a/README.rdoc
+++ /dev/null
@@ -1,2 +0,0 @@
-== Redstoner.com
-I'm too lazy to write something here :D \ No newline at end of file