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

chg: [documentation] fix the name of Stegano.

Browse source
This commit is contained in:
Cédric Bonhomme 2021-04-10 11:49:21 +02:00
parent 96ff4ae620
commit 16e12e8edf
No known key found for this signature in database
GPG key ID: A1CB94DE57B7A70D
4 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/index.rst
View file

@ -6,8 +6,8 @@
Presentation Presentation
============ ============
.. image:: https://builds.sr.ht/~cedric/Stegano.svg .. image:: https://builds.sr.ht/~cedric/stegano.svg
:target: https://builds.sr.ht/~cedric/Stegano :target: https://builds.sr.ht/~cedric/stegano
Stegano_ is a pure Python steganography_ module. Stegano_ is a pure Python steganography_ module.
@ -15,10 +15,10 @@ Stegano_ is a pure Python steganography_ module.
Steganography is the art and science of writing hidden messages in such a way 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 that no one, apart from the sender and intended recipient, suspects the
existence of the message, a form of security through obscurity. existence of the message, a form of security through obscurity.
Consequently, functions provided by Stéganô only hide messages, Consequently, functions provided by Stegano only hide messages,
without encryption. Steganography is often used with cryptography. without encryption. Steganography is often used with cryptography.
Stéganô implements these methods of hiding: Stegano implements these methods of hiding:
- using the red portion of a pixel to hide ASCII messages; - using the red portion of a pixel to hide ASCII messages;
- using the `Least Significant Bit <http://en.wikipedia.org/wiki/Least_significant_bit>`_ (LSB) technique; - using the `Least Significant Bit <http://en.wikipedia.org/wiki/Least_significant_bit>`_ (LSB) technique;
@ -53,7 +53,7 @@ Turorial
steganalysis steganalysis
You can have a look at the You can have a look at the
`unit tests <https://git.sr.ht/~cedric/Stegano/tree/master/tests>`_. `unit tests <https://git.sr.ht/~cedric/stegano/tree/master/tests>`_.
License License
@ -77,7 +77,7 @@ Contact
.. _Python: https://www.python.org .. _Python: https://www.python.org
.. _Stegano: https://git.sr.ht/~cedric/Stegano .. _Stegano: https://sr.ht/~cedric/stegano
.. _`Pillow`: https://pypi.python.org/pypi/Pillow .. _`Pillow`: https://pypi.python.org/pypi/Pillow
.. _`piexif`: https://pypi.python.org/pypi/piexif .. _`piexif`: https://pypi.python.org/pypi/piexif
.. _steganography: http://en.wikipedia.org/wiki/Steganography .. _steganography: http://en.wikipedia.org/wiki/Steganography

8
docs/installation.rst
View file

@ -5,14 +5,14 @@ Installation
$ poetry install Stegano $ poetry install Stegano
You will be able to use Stéganô in your Python programs You will be able to use Stegano in your Python programs
or as a command line tool. or as a command line tool.
If you want to retrieve the source code (with the unit tests): If you want to retrieve the source code (with the unit tests):
.. code-block:: bash .. code-block:: bash
$ git clone https://git.sr.ht/~cedric/Stegano $ git clone https://git.sr.ht/~cedric/stegano
.. image:: https://builds.sr.ht/~cedric/Stegano.svg .. image:: https://builds.sr.ht/~cedric/stegano.svg
:target: https://builds.sr.ht/~cedric/Stegano :target: https://builds.sr.ht/~cedric/stegano

4
docs/module.rst
View file

@ -1,8 +1,8 @@
Using Stéganô as a Python module Using Stegano as a Python module
================================ ================================
You can find more examples in the You can find more examples in the
`unit tests directory <https://git.sr.ht/~cedric/Stegano/tree/master/tests>`_. `unit tests directory <https://git.sr.ht/~cedric/stegano/tree/master/tests>`_.
LSB method LSB method
---------- ----------

6
docs/software.rst
View file

@ -1,4 +1,4 @@
Using Stéganô in command line Using Stegano in command line
============================= =============================
The command ``stegano-lsb`` The command ``stegano-lsb``
@ -149,8 +149,8 @@ In this case, simply use the optional arguments ``--shift``:
.. code-block:: bash .. code-block:: bash
stegano-lsb-set reveal -i ./tests/sample-files/Lenna.png --generator fibonacci --shift 7 stegano-lsb-set reveal -i ./tests/sample-files/Lenna.png --generator fibonacci --shift 7
List all available generators List all available generators
------------------------------ ------------------------------