Updated setup.py for the new release

This commit is contained in:
Cédric Bonhomme 2015-10-06 07:53:01 +02:00
parent 28ba1e54cf
commit cb4c6ed71f
2 changed files with 18 additions and 9 deletions

View file

@ -4,14 +4,17 @@ Stéganô
A Python Steganography module.
# Installation
Installation
------------
$ sudo pip install Stegano
# Use Stéganô as a library in your Python program
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:
If you want to use Stéganô in your Python program you just have to import the
appropriate steganography technique. For example:
>>> from stegano import slsb
@ -19,7 +22,8 @@ If you want to use Stéganô in your Python program you just have to import the
>>> secret.save("./Lenna-secret.png")
# Use Stéganô as a program
Use Stéganô as a program
------------------------
In addition you can use Stéganô as a program.
@ -32,16 +36,19 @@ Another example (hide the message with Sieve of Eratosthenes):
$ slsb-set --hide -i ../examples/pictures/Lenna.png -o Lena2.png --generator eratosthenes -m 'Secret Message'
# Examples
Examples
--------
There are some examples in the folder *examples*.
# Turorial
Turorial
--------
A [tutorial](https://stegano.readthedocs.org/en/latest/tutorial/) is available.
A [tutorial](https://stegano.readthedocs.org/en/latest/tutorial) is available.
# Contact
Contact
-------
[My home page](https://www.cedricbonhomme.org).