diff --git a/HACKING b/HACKING index 646e6d2..089358e 100644 --- a/HACKING +++ b/HACKING @@ -1,6 +1,6 @@ -================== -How to hack Mitter -================== +========================= +Mitter Hacking Guidelines +========================= 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 @@ -61,10 +61,12 @@ you don't need anything). __init__(self, connection, options) ----------------------------------- The initialization will receive two parameters: + - connection: the network connection. Your interface will request any network data with that object. You can check the ``Networks`` object in the ``mitterlib/network/__init__.py`` for methods there (or read the Sphinx documentation generated about it.) + - options: It's a ConfigOpt_ object, with all your interface options. Use it for EVERTYHING that you'd hardcode.