From e87013dee8cd431bf1335c06babd342ad8809463 Mon Sep 17 00:00:00 2001
From: Ryan Lerch <rlerch@redhat.com>
Date: Mar 15 2016 11:31:24 +0000
Subject: Renamed the README to README.md & updated the contents


---

diff --git a/README b/README
deleted file mode 100644
index b991c72..0000000
--- a/README
+++ /dev/null
@@ -1,45 +0,0 @@
-This is the Fedora Websites GIT repo used to build the websites starting
-from the F24 release cycle.
-
-History of previous commits is still available at:
-https://git.fedorahosted.org/cgit/fedora-web.git/
-
-#########################################################################
-#                                                                       #
-#  For all information please read the wiki pages or alternatively:     #
-#  https://docs.pagure.org/fedora-websites/                             #
-#                                                                       #
-#########################################################################
-
-If you like to help the websites team but are not actually a member, you
-can easily file Pull Requests. Fork this repository, make your changes and
-submit them here.
-
-How to get started easily:
-==========================
-
-DO NOT execute the following steps as root, just use your normal user:
-
-1) Setup your system
-
-sudo dnf install git gettext python-genshi python-setuptools python-dateutil \
-python-dogpile-cache babel python-feedparser
-
-sudo dnf groups install 'Web Server'
-
-2) Clone the repo
-
-git clone https://pagure.io/fedora-websites.git
-cd fedora-websites/${website_dir}
-
-3) Launch a test instance
-
-make en test
-
-4) Stop the test instance
-
-make stoptest
-
-* if you have caching problems you can clean the instance even more:
-
-make veryclean
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a2b846
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+This is the Fedora Websites GIT repo used to build the websites starting
+from the F24 release cycle.
+
+History of previous commits is still available in the [old repo on Fedora Hosted](https://git.fedorahosted.org/cgit/fedora-web.git/). **For more information please read the [documentation](https://docs.pagure.org/fedora-websites/) and the [Fedora Websites pages on the Fedora Wiki](https://fedoraproject.org/wiki/Websites)**    
+
+### Contributing
+If you like to help the websites team but are not actually a member, you
+can easily file Pull Requests. Fork this repository, make your changes and
+submit them here. Check of the [Fedora Websites wiki](https://fedoraproject.org/wiki/Websites#Join_the_Websites_Team) for details on how to
+become a member of the websites team
+
+### Websites
+This repository contains the sources for the following Fedora Websites:
+
+* http://arm.fedoraproject.org
+* http://boot.fedoraproject.org
+* http://budget.fedoraproject.org
+* http://fedoracommunity.org
+* http://fedorahosted.org
+* http://fedorapeople.org
+* http://fedoraproject.org
+* http://flocktofedora.org
+* http://fudcon.fedoraproject.org
+* http://getfedora.org
+* http://labs.fedoraproject.org
+* http://mirrors.fedoraproject.org
+* http://spins.fedoraproject.org
+* http://start.fedoraproject.org
+
+### Getting started
+
+**WARNING:** DO NOT execute the following steps as root, just use your normal user:
+
+#### 1. Setup your system
+
+    sudo dnf install git gettext python-genshi python-setuptools python-dateutil \
+    python-dogpile-cache babel python-feedparser
+
+    sudo dnf groups install 'Web Server'
+
+#### 2. Clone the fedora-websites repo
+
+    git clone https://pagure.io/fedora-websites.git
+
+#### 3. Enter the directory of the website you want to work on
+For example, if you want to work on getfedora.org, use:
+
+    cd fedora-websites/getfedora.org
+
+#### 4. Launch a test instance
+
+    make en test
+
+#### 5. Stop the test instance
+
+    make stoptest
+
+**Note:** if you have caching problems you can clean the instance even more:
+
+    make veryclean