Updated documentation and README.

README.md

@@ -41,7 +41,7 @@ Examples
 
 There are some examples in the folder *examples*.
 
-    $ hg clone https://bitbucket.org/cedricbonhomme/stegano
+    $ git clone https://github.com/cedricbonhomme/Stegano.git
     $ cd stegano/examples
 
 

docs/index.rst

@@ -9,32 +9,19 @@ Welcome to Stéganô's documentation!
 .. toctree::
    :maxdepth: 2
 
-Stéganô is a Python steganography_ module.
+Stéganô_ is a Python steganography_ module.
 Steganography is the art and science of writing hidden messages in such a way that no one,
 apart from the sender and intended recipient, suspects the existence of the message, a form
 of security through obscurity. Consequently, functions provided by Stéganô only hide message,
 without encryption. Indeed steganography is often used with cryptography.
 
-The advantage of steganography, over cryptography alone, is that messages do not attract
-attention to themselves. If you are interested in cryptography have a look at my project pySecret.
-
-
-Download Stéganô
-================
-
-You can clone the source code of Stéganô_ :
-
-.. code-block:: bash
-
-    $ hg clone https://bitbucket.org/cedricbonhomme/stegano/
-
-More information about how to install Stéganô in the :doc:`tutorial </tutorial>`.
 
 Requirements
 ============
 
 - Python_ >= 3.2 (tested with Python 3.3.1);
-- `Pillow`_ (friendly fork of Python Imaging Library).
+- `Pillow`_.
+
 
 Methods of hiding
 =================
@@ -57,30 +44,27 @@ Turorial
 
 More information available at the :doc:`tutorial </tutorial>` page
 
+
 License
 =======
 
-Stéganô is under GPL v3 license.
+Stéganô_ is under GPL v3 license.
+
 
 Donation
 ========
 
 If you wish and if you like Stéganô, you can donate via bitcoin. My bitcoin address: `1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ <http://blockexplorer.com/address/1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ>`_
 
+
 Contact
 =======
 
-`My home page <http://cedricbonhomme.org>`_
+`My home page <https://www.cedricbonhomme.org>`_
 
-Indices and tables
-==================
 
-* :ref:`genindex`
+.. _Python: http://python.org
-* :ref:`modindex`
+.. _Stéganô: https://github.com/cedricbonhomme/Stegano
-* :ref:`search`
-
-.. _Python: http://python.org/
-.. _Stéganô: https://bitbucket.org/cedricbonhomme/stegano/
 .. _`Pillow`: https://pypi.python.org/pypi/Pillow
 .. _steganography: http://en.wikipedia.org/wiki/Steganography
 .. _steganalysis: http://en.wikipedia.org/wiki/Steganalysis

docs/tutorial.rst

@@ -1,18 +1,16 @@
-Getting Stéganô
+Getting the source code of Stéganô
-===============
+==================================
 
 .. code-block:: bash
 
-    $ hg clone https://bitbucket.org/cedricbonhomme/stegano
+    $ git clone https://github.com/cedricbonhomme/Stegano.git
-    $ cd stegano/
-    $ chmod u+x *.py # if you want to use Stéganô in command line
 
 Installation
 ============
 
 .. code-block:: bash
 
-    $ python setup.py install
+    $ sudo pip install Stegano
 
 Now you will be able to use Stéganô in your Python program.
 
@@ -38,8 +36,8 @@ Display help
 
 .. code-block:: bash
 
-    $ ./slsb.py --help
+    $ slsb --help
-    Usage: slsb.py [options]
+    Usage: slsb [options]
 
     Options:
     --version             show program's version number and exit
@@ -63,8 +61,8 @@ Hide and reveal a text message
 
 .. code-block:: bash
 
-    $ ./slsb.py --hide -i ./pictures/Lenna.png -o ./pictures/Lenna_enc.png -m HelloWorld!
+    $ slsb --hide -i ./pictures/Lenna.png -o ./pictures/Lenna_enc.png -m HelloWorld!
-    $ ./slsb.py --reveal -i ./pictures/Lenna_enc.png
+    $ slsb --reveal -i ./pictures/Lenna_enc.png
     HelloWorld!
 
 Hide and reveal a binary file
@@ -73,9 +71,9 @@ Hide and reveal a binary file
 .. code-block:: bash
 
     $ wget http://www.gnu.org/music/free-software-song.ogg
-    $ ./slsb.py --hide -i ./pictures/Montenach.png -o ./pictures/Montenach_enc.png -f ./free-software-song.ogg
+    $ slsb --hide -i ./pictures/Montenach.png -o ./pictures/Montenach_enc.png -f ./free-software-song.ogg
     $ rm free-software-song.ogg
-    $ ./slsb.py --reveal -i ./pictures/Montenach_enc.png -b ./song.ogg
+    $ slsb --reveal -i ./pictures/Montenach_enc.png -b ./song.ogg
 
 Hide and reveal a message by using the description field of the image
 ---------------------------------------------------------------------
@@ -90,6 +88,4 @@ Steganalysis
 
 .. code-block:: bash
 
-    $ ./steganalysis-parity.py -i ./pictures./Lenna_enc.png -o ./pictures/Lenna_enc_st.png
+    $ steganalysis-parity -i ./pictures./Lenna_enc.png -o ./pictures/Lenna_enc_st.png
-
-