From 96fb80ad9186c4c90a551ffbe5757b382227de16 Mon Sep 17 00:00:00 2001
From: str4d <str4d@mail.i2p>
Date: Thu, 14 May 2015 03:52:45 +0000
Subject: [PATCH] Nicer format for README

---
 README    | 59 ----------------------------------
 README.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 95 insertions(+), 59 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index b39323d0a..000000000
--- a/README
+++ /dev/null
@@ -1,59 +0,0 @@
-To run locally (for testing purposes):
-
-- Install proxychains, configure it for Tor
-
-- Pull in the dependencies:
-$ proxychains ./setup_venv.sh
-(you can also pull them non-anon by leaving out proxychains)
-
-- Compile translations (if you want to see them):
-$ ./compile-messages.sh
-
-- Start the webserver:
-$ ./runserver.py
-
-- Open the site at http://localhost:5000/
-
-# MIRROR OPERATORS #
-
-If you want to mirror the I2P website, thanks! Here is a checklist:
-
-- Do not edit any of the files in i2p2www/ 
-  - In particular, do not change the CANONICAL_DOMAIN variable in
-    i2p2www/__init__.py, it needs to point to the official site for SEO.
-- If you need to edit variables in etc/update.vars, copy the file to
-  etc/update.vars.custom and edit appropriately. The only variable you
-  may need to edit is MTNURL in etc/update.vars (if your Monotone client
-  tunnel is listening on a different port).
-- If you want to enable caching, copy i2p2www/settings.py.sample to
-  i2p2www/settings.py and edit appropriately.
-- Add ./site-updater.sh to your crontab. This will keep the site updated,
-  recompile the translations when necessary, and touch a file in /tmp/
-  (look in etc/update.vars for the filename, your webserver should restart
-  WSGI when the timestamp of this file changes).
-
-# Updating translations #
-
-- Pull new and updated translations from Transifex:
-$ tx pull -a
-
-- Correctly format the translations:
-$ ./update-existing-po.sh
-
-- Check in the updated translations:
-$ mtn ci i2p2www/translations/ -m "Updated translations"
-
-- Check in any new translations:
-$ mtn add -R i2p2www/translations/ && mtn ci i2p2www/translations/ -m "New translations"
-
-- Update the POT files with any changes to the website text:
-$ ./extract-messages.sh
-
-- Update the translations with any changes to the website text:
-$ ./update-existing-po.sh
-
-- Check in any changes to the website text:
-$ mtn ci pots/ i2p2www/translations/ -m "Updated translation strings"
-
-- Push website text changes to Transifex:
-$ tx push -s
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..7e8d22563
--- /dev/null
+++ b/README.md
@@ -0,0 +1,95 @@
+# I2P website
+
+To run locally (for testing purposes):
+
+- Install proxychains, configure it for Tor
+
+- Pull in the dependencies:
+
+    ```
+    $ proxychains ./setup_venv.sh
+    ```
+
+    (you can also pull them non-anon by leaving out proxychains)
+
+- Compile translations (if you want to see them):
+
+    ```
+    $ ./compile-messages.sh
+    ```
+
+- Start the webserver:
+
+    ```
+    $ ./runserver.py
+    ```
+
+- Open the site at http://localhost:5000/
+
+## Running a mirror
+
+If you want to mirror the I2P website, thanks! Here is a checklist:
+
+- Do not edit any of the files in `i2p2www/` 
+  - In particular, do not change the `CANONICAL_DOMAIN` variable in
+    `i2p2www/__init__.py`, it needs to point to the official site for SEO.
+- If you need to edit variables in `etc/update.vars`, copy the file to
+  `etc/update.vars.custom` and edit appropriately. The only variable you
+  may need to edit is `MTNURL` in `etc/update.vars` (if your Monotone client
+  tunnel is listening on a different port).
+- If you want to enable caching, copy `i2p2www/settings.py.sample` to
+  `i2p2www/settings.py` and edit appropriately.
+- Add `./site-updater.sh` to your crontab. This will keep the site updated,
+  recompile the translations when necessary, and touch a file in `/tmp/`
+  (look in `etc/update.vars` for the filename, your webserver should restart
+  WSGI when the timestamp of this file changes).
+
+## Updating translations
+
+1. Pull new and updated translations from Transifex:
+
+    ```
+    $ tx pull -a
+    ```
+
+2. Correctly format the translations:
+
+    ```
+    $ ./update-existing-po.sh
+    ```
+
+3. Check in the updated translations:
+
+    ```
+    $ mtn ci i2p2www/translations/ -m "Updated translations"
+    ```
+
+4. Check in any new translations:
+
+    ```
+    $ mtn add -R i2p2www/translations/ && mtn ci i2p2www/translations/ -m "New translations"
+    ```
+
+5. Update the POT files with any changes to the website text:
+
+    ```
+    $ ./extract-messages.sh
+    ```
+
+6. Update the translations with any changes to the website text:
+
+    ```
+    $ ./update-existing-po.sh
+    ```
+
+7. Check in any changes to the website text:
+
+    ```
+    $ mtn ci pots/ i2p2www/translations/ -m "Updated translation strings"
+    ```
+
+8. Push website text changes to Transifex:
+
+    ```
+    $ tx push -s
+    ```
-- 
GitLab