fz0x1/Stegano
1
0
Fork 0
mirror of https://github.com/cedricbonhomme/Stegano.git synced 2025-05-12 17:18:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README.

Browse source
This commit is contained in:
Cédric Bonhomme 2016-05-18 09:05:18 +02:00
parent a54a8774bd
commit ac66a9b471
No known key found for this signature in database
GPG key ID: A1CB94DE57B7A70D
1 changed files with 13 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.rst
View file

@ -14,9 +14,19 @@ Installation
$ sudo pip install Stegano
You will be able to use Stéganô in your Python programs or as a command line
tool.
Usage
-----
A `tutorial <https://stegano.readthedocs.org>`_ is available.
There are also some examples in the folder `examples <examples>`_.
Use Stéganô as a library in your Python program
-----------------------------------------------
'''''''''''''''''''''''''''''''''''''''''''''''
If you want to use Stéganô in your Python program you just have to import the
appropriate steganography technique. For example:
@ -29,34 +39,19 @@ appropriate steganography technique. For example:
Use Stéganô as a program
------------------------
In addition you can use Stéganô as a program.
Example:
''''''''''''''''''''''''
.. code:: bash
$ slsb --hide -i ../examples/pictures/Lenna.png -o Lena1.png -m "Secret Message"
Another example (hide the message with Sieve of Eratosthenes):
Hide the message with Sieve of Eratosthenes:
.. code:: bash
$ slsb-set --hide -i ../examples/pictures/Lenna.png -o Lena2.png --generator eratosthenes -m 'Secret Message'
Examples
--------
There are some examples in the folder *examples*.
.. code:: bash
$ git clone https://github.com/cedricbonhomme/Stegano.git
$ cd stegano/examples
Running the tests
-----------------
@ -65,12 +60,6 @@ Running the tests
$ python -m unittest discover -v
Turorial
--------
A `tutorial <https://stegano.readthedocs.org>`_ is available.
Contact
-------