Browse Source

Fixed readme

Ralfp 12 years ago
parent
commit
f07bf4fbe4
1 changed files with 12 additions and 10 deletions
  1. 12 10
      README.md

+ 12 - 10
README.md

@@ -1,18 +1,18 @@
 Misago
 Misago
 ======
 ======
 
 
-Misago is internet forum application written in Python and using Django as its foundation.
+Misago is an internet forum application written in Python and using Django as its foundation.
 Visit project homepage for discussion and demo: <http://misago-project.org>
 Visit project homepage for discussion and demo: <http://misago-project.org>
 
 
 
 
 The Tao AKA Mission Statement
 The Tao AKA Mission Statement
 -----------------------------
 -----------------------------
 
 
-I want software focused on enabling smooth flow of information between forum members. I dont want to build "Facebook CMS" that contains lots of extra functionality like user galleries, blogs or user walls. Posting and replying in threads is only focus of Misago with additional features implemented to improve forum users and staff experience.
+I want software focused on enabling smooth flow of information between forum members. I don't want to build a "Facebook CMS" that contains lots of extra functionality like user galleries, blogs or user walls. Posting and replying in threads is the only focus of Misago with additional features implemented to improve forum users and staff experience.
 
 
-Secondary goal is making Misago a viable foundation for building and maintaining long-term discussion forums for administrators. Misago trades "casual admin" friendlyness for advanced features aimed for use by web developers looking for tool to build forums for their site.
+Secondary goal is making Misago a viable foundation for building and maintaining long-term discussion forums for administrators. Misago trades "casual admin" friendliness for advanced features aimed for use by web developers looking for a tool to build forums for their site.
 
 
-Finally while Misago is build using Django, its not "Django application" and it wont integrate with existing Django projects. This is result of design decision to use custom users/session/auth/permissions functionality instead of Django native applications - however in future Misago will provide web API allowing you to add Misago-powered features to your website.
+Finally while Misago is built using Django, it's not a "Django application" and it won't integrate with existing Django projects. This is the result of design decision to use custom users/session/auth/permissions functionality instead of Django native applications - however in the future Misago will provide a web API allowing you to add Misago-powered features to your website.
 
 
 
 
 Dependencies
 Dependencies
@@ -27,7 +27,7 @@ Dependencies
 * [path](http://pypi.python.org/pypi/path.py)
 * [path](http://pypi.python.org/pypi/path.py)
 * [Pillow](http://pypi.python.org/pypi/Pillow/)
 * [Pillow](http://pypi.python.org/pypi/Pillow/)
 * [pyTZ](http://pypi.python.org/pypi/pytz/2012h)
 * [pyTZ](http://pypi.python.org/pypi/pytz/2012h)
-* [reCAPTCHA](http://pypi.python.org/pypi/recaptcha-client)
+* [reCAPTCHA-client](http://pypi.python.org/pypi/recaptcha-client)
 * [South](http://south.aeracode.org)
 * [South](http://south.aeracode.org)
 * [Unidecode](http://pypi.python.org/pypi/Unidecode)
 * [Unidecode](http://pypi.python.org/pypi/Unidecode)
 
 
@@ -35,9 +35,11 @@ Dependencies
 Installation
 Installation
 ------------
 ------------
 
 
-Misago comes with "deployment" python module that contains empty Misago configuration and default Django WSGI container for you to use in your deployments.
+The very first thing that needs to be done is ensure you have all the dependencies installed. Most can be installed through `pip`.
 
 
-After you set low-level configuration of Misago, fire following commands on manage.py:
+Misago comes with the "deployment" Python module that contains empty Misago configuration and default Django WSGI container for you to use in your deployments.
+
+After you set low-level configuration of Misago (`settings/settings.py`), fire the following commands on manage.py through the Python executable:
 
 
 * __startmisago__ - creates DB structure for Misago and populates it with default data
 * __startmisago__ - creates DB structure for Misago and populates it with default data
 * __adduser Admin admin@example.com password --admin__ - this will create first admin user
 * __adduser Admin admin@example.com password --admin__ - this will create first admin user
@@ -47,7 +49,7 @@ https://docs.djangoproject.com/en/dev/howto/deployment/
 
 
 Don't forget to set up maintenance cronjobs to keep your database clean, look into cront.txt file to see what crons to set up.
 Don't forget to set up maintenance cronjobs to keep your database clean, look into cront.txt file to see what crons to set up.
 
 
-While Misago will run without cache set up, you are stronly encouraged to set one up for it.
+While Misago will run without cache set up, you are strongly encouraged to set one up for it. Even if you choose not to run one, you will still need to set a default one (such as dummy caching).
 
 
 ### WARNING!
 ### WARNING!
 
 
@@ -65,9 +67,9 @@ If you want to move data from 0.1 to 0.2, install 0.2 to new database, then add
 Contributing
 Contributing
 ------------
 ------------
 
 
-Misago is open source project. You are free to submit pull requests against master branch, but I request all interested in contributing to project to register on project forums and participate in [development discussion](http://misago-project.org/category/development-discussion-17/).
+Misago is open source project. You are free to submit pull requests against master branch, and use issues system to report bugs, propose improvements and new features.
 
 
-Finally, you can participate in discussion on [project forums](http://misago-project.org). Your feedback means much for project, don't keep it to yourself!
+Finally, you can participate in discussion on [project forums](http://misago-project.org). Your feedback means much more for the project, don't keep it to yourself!
 
 
 
 
 Authors
 Authors