doc: licensing and homogeneization

emse-sas · Oct 20, 2020 · 8e3f40a · 8e3f40a
1 parent 6e919f1
commit 8e3f40a
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 40 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,5 @@ media/
 .pytest_cache/
 docs/build
 deploy_sca
-deploy_sca.pub
+deploy_sca.pub
+.
diff --git a/.travis.yml b/.travis.yml
@@ -14,7 +14,7 @@ scripts:
 - echo "Generating documentation..."
 - cd docs/sources
 - make html
-- cd ../build/all/html
+- cd ../build/html
 - touch .nojekyll
 - cd ../../../../
 
@@ -26,7 +26,7 @@ deploy:
   provider: pages:git
   email: sami@dahoux.net
   deploy_key: deploy_sca
-  local_dir: docs/build/all/html
+  local_dir: docs/build/html
   keep_history: true
   edge: true
   on:

diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Dahoux Sami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.rst b/README.rst
@@ -2,6 +2,7 @@ SCABox Attack Demo
 ***************************************************************
 
 .. image:: https://api.travis-ci.com/samiBendou/sca-automation.svg?token=LqpGzZ56omzjYoep5ESp&branch=master
+    :target:https://travis-ci.com/samiBendou/sca-automation
 
 Overview
 ===============================================================
@@ -89,6 +90,16 @@ Documentation
 
 The complete documentation of the project is available `here <https://samibendou.github.io/sca-automation/>`_.
 
+Build
+---------------------------------------------------------------
+
+You can build the documentation of the library and application using sphinx and autodoc
+
+.. code-block:: shell
+
+    $ cd sca-automation/docs/sources
+    $ make html
+
 More
 ===============================================================
 
@@ -103,4 +114,20 @@ SCABox is an open-source project, all the sources are hosted on GitHub
 - `IP repository <https://github.com/samiBendou/sca-ip/>`_
 - `Acquisition demo <https://github.com/samiBendou/sca-demo-tdc-aes/>`_
 - `Attack demo <https://github.com/samiBendou/sca-automation/>`_
-- `SCABox website  <https://github.com/samiBendou/sca_framework/>`_
+- `SCABox website  <https://github.com/samiBendou/sca_framework/>`_
+
+Contributing
+---------------------------------------------------------------
+
+Please feel free to take part into SCABox project, all kind of contributions are welcomed.
+
+The project aims at gathering a significant number of IP cores, crypto-algorithms and attack models 
+in order to provide an exhaustive view of today's remote SCA threat.
+
+Software and embedded improvements are also greatly welcomed. Since the project is quite vast and invovles
+a very heterogeneous technical stack, it is difficult to maintain the quality with a reduced size team.  
+
+License
+---------------------------------------------------------------
+
+All the contents of the SCABox project are licensed under the `MIT license <https://choosealicense.com/licenses/mit/>` provided in each GitHub repository.
diff --git a/docs/sources/Makefile b/docs/sources/Makefile
@@ -6,7 +6,7 @@
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
-BUILDDIR      = ../build/all
+BUILDDIR      = ../build/
 
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/docs/sources/index.rst b/docs/sources/index.rst
@@ -1,4 +1,4 @@
-Welcome to the SCABox documentation!
+Welcome to the SCABox documentation !
 ***************************************************************
 
 Reference

diff --git a/docs/sources/make.bat b/docs/sources/make.bat
@@ -8,7 +8,7 @@ if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
 set SOURCEDIR=.
-set BUILDDIR=../../build/all
+set BUILDDIR=../../build/
 
 if "%1" == "" goto help
 

diff --git a/pushdoc.sh b/pushdoc.sh