From 16e12e8edfe5d340a0126bf991f26ddc27452510 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Bonhomme?= Date: Sat, 10 Apr 2021 11:49:21 +0200 Subject: [PATCH] chg: [documentation] fix the name of Stegano. --- docs/index.rst | 12 ++++++------ docs/installation.rst | 8 ++++---- docs/module.rst | 4 ++-- docs/software.rst | 6 +++--- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 875f65e..f5ed1c2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,8 +6,8 @@ Presentation ============ -.. image:: https://builds.sr.ht/~cedric/Stegano.svg - :target: https://builds.sr.ht/~cedric/Stegano +.. image:: https://builds.sr.ht/~cedric/stegano.svg + :target: https://builds.sr.ht/~cedric/stegano 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 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 messages, +Consequently, functions provided by Stegano only hide messages, 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 `Least Significant Bit `_ (LSB) technique; @@ -53,7 +53,7 @@ Turorial steganalysis You can have a look at the -`unit tests `_. +`unit tests `_. License @@ -77,7 +77,7 @@ Contact .. _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 .. _`piexif`: https://pypi.python.org/pypi/piexif .. _steganography: http://en.wikipedia.org/wiki/Steganography diff --git a/docs/installation.rst b/docs/installation.rst index 102459d..ae3a371 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,14 +5,14 @@ Installation $ 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. If you want to retrieve the source code (with the unit tests): .. 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 - :target: https://builds.sr.ht/~cedric/Stegano +.. image:: https://builds.sr.ht/~cedric/stegano.svg + :target: https://builds.sr.ht/~cedric/stegano diff --git a/docs/module.rst b/docs/module.rst index 9d8daf6..3b2273c 100644 --- a/docs/module.rst +++ b/docs/module.rst @@ -1,8 +1,8 @@ -Using Stéganô as a Python module +Using Stegano as a Python module ================================ You can find more examples in the -`unit tests directory `_. +`unit tests directory `_. LSB method ---------- diff --git a/docs/software.rst b/docs/software.rst index b73f0b8..3e232f8 100644 --- a/docs/software.rst +++ b/docs/software.rst @@ -1,4 +1,4 @@ -Using Stéganô in command line +Using Stegano in command line ============================= The command ``stegano-lsb`` @@ -149,8 +149,8 @@ In this case, simply use the optional arguments ``--shift``: .. code-block:: bash stegano-lsb-set reveal -i ./tests/sample-files/Lenna.png --generator fibonacci --shift 7 - - + + List all available generators ------------------------------