From 42908c0ecabf0bd4a909d77c37f60e2a8661d85b Mon Sep 17 00:00:00 2001
From: Michael Kapelko <kornerr@gmail.com>
Date: Wed, 27 Jun 2018 10:53:05 +0300
Subject: [PATCH] Clarify README

---
 README.md | 59 +++++++++++++++++++++++++++++++------------------------
 1 file changed, 33 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index 9cf26e9..66dadc4 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,53 @@
 # Overview
 
-We consider changing [Opensource Game Studio website](http://opengamestudio.org)'s
-engine from Wordpress to [Pelican](http://getpelican.com). This is Pelican
-evaluation.
+This is an internal document describing how to update
+[Opensource Game Studio website][opengamestudio]
+powered by [Pelican][pelican].
 
 # Installation
 
-You need a working Python's `pip`.
-
 Install Pelican with the following command:
 
-`sudo apt install pelican`
+```
+sudo apt install pelican
+```
 
 # Preview
 
-* Generate local copy with the following commands:
-
-`cd pelican`
-
-`pelican -s pelicanconf.py`
+To preview results locally:
 
-* Serve the local copy with the following commands:
+* generate local copy with the following commands:
+    ```
+    cd pelican
+    pelican -s pelicanconf.py
+    ```
+* serve the local copy with the following commands:
+    ```
+    cd output
+    python -m SimpleHTTPServer
+    ```
 
-`cd output`
-
-`python -m SimpleHTTPServer`
-
-The preview should now be available at
-[http://localhost:8000](http://localhost:8000).
+The preview should now be available at [http://localhost:8000][preview].
 
 # Publishing
 
-* Generate public site with the following commands:
-
-`cd pelican`
+To publish new content:
 
-`pelican -s publishconf.py`
+* generate public site with the following commands:
+    ```
+    cd pelican
+    pelican -s publishconf.py
+    ```
 
-* Upload it to GitHub with the following commands:
+* upload it to GitHub with the following command:
+    ```
+    git push
+    ```
 
-`git push`
+The public site should now be available at
+[Opensource Game Studio website][opengamestudio].
 
-The publich site should now be available at
-[http://kaisd.github.io/ogs-site](http://kaisd.github.io/ogs-site).
+[opengamestudio]: http://opengamestudio.org
+[pelican]: http://getpelican.com
+[preview]: http://localhost:8000