jbiason
/
Mitter
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Updated documentation

master
Julio Biason 15 years ago
parent
d3da64f71a
commit
b10a794110
3 changed files with 18 additions and 18 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 11
      HACKING
  2. 15
      INSTALL
  3. 8
      README

11
HACKING
Unescape View File

@ -1,9 +1,7 @@
======= ==================
HACKING
=======
How to hack Mitter How to hack Mitter
================== ==================
First of all, Mitter is a Python project and it tries to follow PEP8_ 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 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 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 Documentation
============= =============
Also, all documentation (including this file!) follows the Sphinx_ All documentation (including this file!) follows the Sphinx_ format
format (ReSTructured_ format). This includes docstrings and external (ReSTructured_ format). This includes docstrings and external files.
files.
Creating Interfaces Creating Interfaces
=================== ===================

15
INSTALL
Unescape View File

@ -1,6 +1,6 @@
======= =====================
INSTALL How To Install Mitter
======= =====================
Requirements 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 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 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 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
============ ============
Installation follows the default Python apps install: Installation follows the default way of installing Python apps:
Using easy_install Using easy_install
------------------ ------------------
You can install using easy_install. To install, simply call You can install Mitter using easy_install. To install, simply call
``easy_install mitter``. It may require root access to install some ``easy_install mitter``. It may require root access to install some
files. files.
easy_install will download the latest version registered on Cheese Shop
( http://pypi.python.org ), unpack and install it.
Using setup.py Using setup.py
-------------- --------------

8
README
Unescape View File

@ -1,11 +1,11 @@
====== =======
README Read Me
====== =======
About Mitter About Mitter
============ ============
Mitter is a multi-protocol, multi-interface client for micro-blogging Mitter is a multi-protocol, multi-interface client for micro-blogging
sites. networks.
Options Options
======= =======

Write Preview
Loading…
Cancel
Save