aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..8b957db68
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Homebrew webpage
+
+The webpage uses [jekyll](https://github.com/mojombo/jekyll). The template for the index is at layouts/index.html.
+
+## Translations
+If you want to add a new translation, follow these steps:
+
+1. In _config.yml append this:
+
+ ```
+ - langcode: {the_lang_code}
+ lang_string: {the_link_string}
+ ```
+2. Copy index.html as index_{langcode}.html
+3. Change the values of the strings to the translated strings.
+
+You can see the translated webpage by running `jekyll --server` and opening http://localhost:4000/