diff --git a/HACKING b/HACKING index 4d4de69..d9a7d08 100644 --- a/HACKING +++ b/HACKING @@ -1,9 +1,7 @@ -======= -HACKING -======= - +================== How to hack Mitter ================== + First of all, Mitter is a Python project and it tries to follow PEP8_ as close as possible. Sometimes, we fail, but we try to adhere to it as much as possible. The Google Guidelines_ for Python are a good @@ -25,9 +23,8 @@ summary about it, although we don't follow all their recommendations: Documentation ============= -Also, all documentation (including this file!) follows the Sphinx_ -format (ReSTructured_ format). This includes docstrings and external -files. +All documentation (including this file!) follows the Sphinx_ format +(ReSTructured_ format). This includes docstrings and external files. Creating Interfaces =================== diff --git a/INSTALL b/INSTALL index d4a4ae0..ba8247b 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,6 @@ -======= -INSTALL -======= +===================== +How To Install Mitter +===================== Requirements ============ @@ -13,20 +13,23 @@ For the GTK interface, you'll need PyGTK installed. The minimum version is 2.10 and Mitter should work fine with any further version in the 2.x series. Again, there is no guarantee that it will work with GTK 3.0 when it's released. Also notice that PyGTK is optional and -Mitter will use it's console interfaces in this case. +Mitter will use its console interfaces in this case. Installation ============ -Installation follows the default Python apps install: +Installation follows the default way of installing Python apps: Using easy_install ------------------ -You can install using easy_install. To install, simply call -``easy_install mitter``. It may require root access to install some +You can install Mitter using easy_install. To install, simply call +``easy_install mitter``. It may require root access to install some files. +easy_install will download the latest version registered on Cheese Shop +( http://pypi.python.org ), unpack and install it. + Using setup.py -------------- diff --git a/README b/README index fe1aa78..81b3422 100644 --- a/README +++ b/README @@ -1,11 +1,11 @@ -====== -README -====== +======= +Read Me +======= About Mitter ============ Mitter is a multi-protocol, multi-interface client for micro-blogging -sites. +networks. Options =======