Browse Source

Converted readme do rst

Rafał Pitoń 11 years ago
parent
commit
ca532451df
3 changed files with 24 additions and 16 deletions
  1. 0 0
      LICENSE.rst
  2. 23 15
      README.rst
  3. 1 1
      setup.py

+ 0 - 0
LICENSE.md → LICENSE.rst


+ 23 - 15
README.md → README.rst

@@ -1,18 +1,26 @@
+======
 Misago
 ======
-[![Build Status](https://travis-ci.org/rafalp/Misago.png?branch=future)](https://travis-ci.org/rafalp/Misago)
-[![Coverage Status](https://coveralls.io/repos/rafalp/Misago/badge.png?branch=future)](https://coveralls.io/r/rafalp/Misago?branch=future)
-[![Code Health](https://landscape.io/github/rafalp/Misago/future/landscape.png)](https://landscape.io/github/rafalp/Misago/future)
 
-**Branch Status: _Not Functional_**
+.. image:: https://travis-ci.org/rafalp/Misago.png?branch=future
+  :target: https://travis-ci.org/rafalp/Misago
+
+.. image:: https://coveralls.io/repos/rafalp/Misago/badge.png?branch=future
+  :target: https://coveralls.io/r/rafalp/Misago?branch=future
+
+.. image:: https://landscape.io/github/rafalp/Misago/future/landscape.png
+  :target: https://landscape.io/github/rafalp/Misago/future
+
+
+**Development Status: Pre-Alpha**
 
 Misago aims to be complete, featured and modern forum solution that has no fear to say 'NO' to common and outdated opinions about how forum software should be made and what it should do.
 
 If you can run Python apps on your hosting and you are looking for modern solution using latest paradigms in web development, or you are Django developer and forum is going to be core component of your next project then Misago is option for you!
 
-* **Homepage:** <http://misago-project.org/>
-* **Documentation:** <http://misago.readthedocs.org/en/latest/>
-* **Code & BugTracker:** <https://github.com/rafalp/Misago/>
+* **Homepage:** http://misago-project.org/
+* **Documentation:** http://misago.readthedocs.org/en/latest/
+* **Code & BugTracker:** https://github.com/rafalp/Misago/
 
 
 Installing and updating
@@ -20,15 +28,15 @@ Installing and updating
 
 Branch *future* is used for project's codebase cleanup and is not functional at the time of this writing.
 
-If you want to give Misago a spin, feel free to play with one of [previous releases](https://github.com/rafalp/Misago/releases).
+If you want to give Misago a spin, feel free to play with one of `previous releases <https://github.com/rafalp/Misago/releases>`_.
 
 
 Bug reports and feature requests
 --------------------------------
 
-If you have found bug, please report it on [issue tracker](https://github.com/rafalp/Misago/issues).
+If you have found bug, please report it on `issue tracker <https://github.com/rafalp/Misago/issues>`_.
 
-For feature or support requests as well as general feedback please use our [project forums](http://misago-project.org) instead. Your feedback means much to the project so please do share your thoughts!
+For feature or support requests as well as general feedback please use our zproject forums <http://misago-project.org>`_ instead. Your feedback means much to the project so please do share your thoughts!
 
 
 Contributing
@@ -46,16 +54,16 @@ Authors
 
 **Rafał Pitoń**
 
-http://rpiton.com
-http://github.com/rafalp
-https://twitter.com/RafalPiton
+* http://rpiton.com
+* http://github.com/rafalp
+* https://twitter.com/RafalPiton
 
 
 Copyright and license
 ---------------------
 
-__Misago__ - Copyright © 2014 [Rafał Pitoń](http://github.com/ralfp)
+**Misago** - Copyright © 2014 `Rafał Pitoń <http://github.com/ralfp>`_
 This program comes with ABSOLUTELY NO WARRANTY.
 
 This is free software and you are welcome to modify and redistribute it under the conditions described in the license.
-For the complete license, refer to [LICENSE.md](LICENSE.md)
+For the complete license, refer to LICENSE.rst

+ 1 - 1
setup.py

@@ -3,7 +3,7 @@ import os
 from setuptools import setup
 from misago import __version__ as version
 
-README = open(os.path.join(os.path.dirname(__file__), 'README.md')).read()
+README = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()
 
 with open("requirements.txt", "r") as f:
     REQUIREMENTS = [x.strip() for x in f.readlines()]