README.md

 

This is the Degate documentation repository. Degate is a multi-platform software for semi-automatic VLSI reverse engineering of digital logic in chips. This project is a fork of the initial Degate project, the final goal is to replace it. For more please visit our wiki page and, if you want to chat, visit our Gitter. The current project maintainer is Dorian Bachelot.

 

• Build
  • Dependencies
  • Quick start
    • For Linux (debian-like)
    • For Windows
    • For all platform
• Localization
  • Add/Update a language
  • Generate documentation
    • For BSD/GNU:
    • For Windows cmd.exe:
    • For Windows PowerShell:
• License

 

Build

Dependencies

• Python 3,
• Sphinx,
• Read the Docs Sphinx Theme.

Quick start

Firstly, clone this repository (help here).

For Linux (debian-like)

Install dependencies:

> sudo apt-get install python3

For Windows

Install dependencies:

• CMake: https://cmake.org/download/
• Python 3: https://www.python.org/downloads/

For all platform

Install sphinx and read-the-docs (with administrator privileges):

> pip install sphinx
> pip install sphinx-rtd-theme

Then you just have to select the build type, for example:

> make html

The documentation will be built in the 'build' folder.

Localization

In these generated files (under 'locale/desired_language_identifier/' directory) you will be able to translate strings of the documentation.

To make the translation process easier you can use a '.po' file editor like Poedit.

Add/Update a language

To add or update a language, please follow below steps.

Install dependencies:

> pip install sphinx-intl

Then, generate pot files in the 'build/gettext' directory.

> make gettext

Now we need to generate '.po' files. Use the command below and replace the 'desired_language_identifier' variable with the desired language identifier. A list is available here.

> sphinx-intl update -p build/gettext -l desired_language_identifier

Generate documentation

To generate documentation in a specific language, use these commands:

For BSD/GNU:

> make -e SPHINXOPTS="-D language='desired_language_identifier'" html

For Windows cmd.exe:

> set SPHINXOPTS=-D language=desired_language_identifier
> make.bat html

For Windows PowerShell:

> Set-Item env:SPHINXOPTS "-D language=desired_language_identifier"
> make.bat html

For more please see : https://www.sphinx-doc.org/en/master/usage/advanced/intl.html.

License

Degate is released under the GNU General Public License Version 3. See LICENSE file for details.