rename README to README.md and update it as markdown

diff --git a/.gitignore b/.gitignore
index ad3677d..c54e5cf 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,31 @@
-build/
 kickstart/__init__.py
 kickstart/kickstart.py
-*~
\ No newline at end of file
+*~
+
+*.py[co]
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+
+#Translations
+*.mo
+
+#Mr Developer
+.mr.developer.cfg

diff --git a/README b/README.md
similarity index 55%
rename from README
rename to README.md
index ab16ab1..ac2f925 100644 (file)
--- a/README
+++ b/README.md
@@ -1,20 +1,36 @@
+kickstarter
+===========
+
+Kickstart file generator based on YAML formated meta data
+
+Installation
+------------
+
 Install cheetah (http://www.cheetahtemplate.org/) templating system, PyYAML.
 
 run make
 sudo python setup.py install
-then run:
+
+Usage
+-----
+
 kickstarter -c <images.yaml> -r <repos.yaml>
 
 Example:
- kickstarter  --configs configurations.yaml --repos repos.yaml 
 
- This configuration.yaml file is an example only, for meego kickstart files,
- consult the image-configurations package
+    kickstarter  --configs configurations.yaml --repos repos.yaml 
+
+This configuration.yaml file is an example only, for meego kickstart files,
+consult the image-configurations package
+
+Repo file
+---------
 
-Repo file:
 This file contains a list of repositories to be used in the kickstart files
 
-Configurations file:
+Configurations file
+-------------------
+
 This file has the definition of configurations. The Configurations inherit 
 from platforms first then from the DEFAULT section. The image configurations
 override the all other settings (in DEFAULT and platform sections).