map 0x0000041d include common # # Top row # section 0x29 onehalf 0x29 shift # 1 exclam 0x2 shift # 2 quotedbl 0x3 shift at 0x3 altgr # 3 numbersign 0x4 shift sterling 0x4 altgr # 4 currency 0x5 shift dollar 0x5 altgr # 5 percent 0x6 shift # 6 ampersand 0x7 shift # 7 slash 0x8 shift braceleft 0x8 altgr # 8 parenleft 0x9 shift bracketleft 0x9 altgr # 9 parenright 0xa shift bracketright 0xa altgr # 0 equal 0xb shift braceright 0xb altgr plus 0xc question 0xc shift backslash 0xc altgr acute 0xd dead_acute 0xd grave 0xd shift dead_grave 0xd shift # # QWERTY first row # EuroSign 0x12 altgr aring 0x1a Aring 0x1a shift dead_diaeresis 0x1b dead_circumflex 0x1b shift dead_tilde 0x1b altgr # # QWERTY second row # odiaeresis 0x27 Odiaeresis 0x27 shift adiaeresis 0x28 Adiaeresis 0x28 shift apostrophe 0x2b asterisk 0x2b shift # # QWERTY third row # less 0x56 greater 0x56 shift bar 0x56 altgr mu 0x32 altgr comma 0x33 semicolon 0x33 shift period 0x34 colon 0x34 shift minus 0x35 underscore 0x35 shift > [no description]
aboutsummaryrefslogtreecommitdiffstats
path: root/doc/development/Documentation.rst
blob: 3649865423faac47cd4f68ba131fcd8893b23cb2 (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14

.. _DEV:Documentation:

Documentation
#############

* Using/Synthesis: formal verification, etc.
* Development/libghdl. How to interact with GHDL through ``libghdl`` and/or ``libghdl-py``.
* Development/Related Projects. Brief discussion about similarities/differences with other open source projects such as rust_hdl or pyVHDLParser.
* Usage/Docker. Probably copy/convert :file:`README.md` and :file:`USE_CASES.md` in ghdl/docker :ghdlsharp:`166`.
* Usage/Language Server.
* Usage/Examples/Coverage. Code coverage in GHDL is a side effect of using GCC as a backend. In the future, GCC backend support might be dropped in favour of mcode and LLVM. To do so, code coverage with LLVM should be supported first. Anyway, comments/bits of info should be gathered somewhere in the docs, along with references to gcov, lcov, etc.
* Usage/Examples/UART. Dossmatik's UART and unisim guides. We have ``*.doc`` sources to be converted to Sphinx.
* Usage/Examples/Free Range VHDL. https://github.com/fabriziotappero/Free-Range-VHDL-book
* It is possible to add waveforms with wavedrom, since there is a sphinx extension available.
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-14 17:56:52 +0000