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

Minor updates to the documentation.

Browse source
This commit is contained in:
Cédric Bonhomme 2018-11-22 10:23:54 +01:00
parent bd5b156453
commit a86361dd27
No known key found for this signature in database
GPG key ID: A1CB94DE57B7A70D
2 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/conf.py
View file

@ -40,8 +40,8 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Stéganô' project = u'Stegano'
copyright = u'2012-2017, Cédric Bonhomme' copyright = u'2012-2018, Cédric Bonhomme'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@ -50,7 +50,7 @@ copyright = u'2012-2017, Cédric Bonhomme'
# The short X.Y version. # The short X.Y version.
version = '0.8' version = '0.8'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.8.1' release = '0.8.6'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -183,7 +183,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'Stgan.tex', u'Stéganô Documentation', ('index', 'Stgan.tex', u'Stegano Documentation',
u'Cédric Bonhomme', 'manual'), u'Cédric Bonhomme', 'manual'),
] ]
@ -227,7 +227,7 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'Stgan', u'Stéganô Documentation', ('index', 'Stgan', u'Stegano Documentation',
u'Cédric Bonhomme', 'Stgan', 'One line description of project.', u'Cédric Bonhomme', 'Stgan', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]

10
docs/index.rst
View file

@ -24,7 +24,7 @@ Presentation
.. image:: https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg?style=flat-square .. image:: https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg?style=flat-square
:target: https://saythanks.io/to/cedricbonhomme :target: https://saythanks.io/to/cedricbonhomme
Stéganô_ is a pure Python steganography_ module. 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
@ -44,6 +44,8 @@ Moreover some methods of steganalysis_ are provided:
- steganalysis of LSB encoding in color images; - steganalysis of LSB encoding in color images;
- statistical steganalysis. - statistical steganalysis.
You can also use Stegano through this `Web service <https://stegano-web.herokuapp.com>`_.
Not all functionalities of Stegano are covered.
Requirements Requirements
============ ============
@ -64,20 +66,20 @@ Turorial
software software
steganalysis steganalysis
You can also have a look at the You can have a look at the
`unit tests <https://github.com/cedricbonhomme/Stegano/tree/master/tests>`_. `unit tests <https://github.com/cedricbonhomme/Stegano/tree/master/tests>`_.
License License
======= =======
Stéganô_ is under GPL v3 license. Stegano_ is under GPL v3 license.
Donation Donation
======== ========
If you wish and if you like Stéganô, you can donate via bitcoin. If you wish and if you like Stegano, you can donate via bitcoin.
My bitcoin address: `1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ <http://blockexplorer.com/address/1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ>`_ My bitcoin address: `1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ <http://blockexplorer.com/address/1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ>`_