amateurfunk/hamnet70
2
0
Fork 0
Code Issues Pull requests 1 Actions Packages Projects Releases Wiki Activity
233 commits 4 branches 1 tag 2.1 MiB
Commit graph

24 commits

Author SHA1 Message Date
Thomas Kolb 1ae421e876 doc: add state diagrams
All checks were successful
/ build-hamnet70 (push) Successful in 27s
Details
/ build-doc (push) Successful in 16s
Details
/ deploy-doc (push) Has been skipped
Details
2024-09-21 00:55:25 +02:00
Thomas Kolb c61a7a7cf7 doc: start documenting the Layer 2 packets (WIP)
All checks were successful
/ build-hamnet70 (push) Successful in 26s
Details
/ build-doc (push) Successful in 15s
Details
/ deploy-doc (push) Has been skipped
Details
2024-08-30 23:46:47 +02:00
Simon Ruderich 3f4a50bdce doc: don't use external resources
All checks were successful
/ build-hamnet70 (push) Successful in 26s
Details
/ build-doc (push) Successful in 15s
Details
/ deploy-doc (push) Has been skipped
Details 
Embedding (only) parts of MathJax is a bit ugly ...
 2024-08-28 13:42:33 +02:00
Thomas Kolb c342cf656e Move documentation docker scripts to /ci/docker 2024-08-27 21:28:09 +02:00
Thomas Kolb f686635837 doc: automatic builds and deployment using Forgejo Actions
All checks were successful
/ build-doc (push) Successful in 14s
Details
/ deploy-doc (push) Successful in 9s
Details 
Actions run in a custom Docker image built by the scripts in `doc/docker`.
There are two jobs that run in sequence:

- `build-doc`: builds the documentation from the AsciiDoc sources.
- `deploy-doc`: Uploads the generated files to http://0fm.de
 2024-08-27 21:10:30 +02:00
Thomas Kolb 10f634d144 doc: translate message sequence diagrams to mscgen 
Mermaid is more beautiful, but the tool stack is really annoying. A Chrome
browser should not be necessary to generate some SVGs.
 2024-08-27 18:07:12 +02:00
Thomas Kolb 303bfaec4f doc: enable stem processing for formulas 2024-08-25 01:14:38 +02:00
Thomas Kolb 76f9f37b5d doc/Makefile: add clean target 2024-08-25 01:14:28 +02:00
Thomas Kolb 9d86bc3c97 doc: write generated files to separate directory 2024-08-25 00:52:51 +02:00
Thomas Kolb 2e91fd7c42 Apply free software+documentation licenses 
All code is now licensed under GPLv3+. The documentation is licensed under
CC BY-SA 4.0.

This is now officially free software! \o/
 2024-08-23 11:53:40 +02:00
Simon Ruderich fe3460a899 doc: s/should/must/ 2024-07-23 09:21:14 +02:00
Thomas Kolb 87eeb045b0 docs: define an Empty Frame and its usage 2024-07-22 21:40:54 +02:00
Thomas Kolb 55ec709001 doc: ignore generated diagrams 2024-07-01 21:02:13 +02:00
Thomas Kolb 1840b3099c doc: add some message sequence charts 
- Connection establishment
- Connection close
- Packet transfer
 2024-06-22 01:29:29 +02:00
Thomas Kolb 95d9eda0a0 doc: add introduction + some more ideas 2024-06-08 11:49:43 +02:00
Thomas Kolb dde4e5ba7d doc: moved CRC from layer 1 to layer 2 2024-06-08 11:34:52 +02:00
Thomas Kolb c45eb4e334 doc: define connectionless frame type 2024-06-08 11:34:52 +02:00
Thomas Kolb 6fe9fdbe2b doc: minor clarifications 2024-06-08 11:34:52 +02:00
Thomas Kolb 8fb345b27c doc: automatic packet repetition algorithm 2024-06-08 11:34:52 +02:00
Thomas Kolb 6065157023 doc: added Makefile 2024-06-08 11:34:52 +02:00
Thomas Kolb 698cf74f3a doc: document data whitening procedure 2024-06-08 11:34:52 +02:00
Thomas Kolb ccc4e452ff doc: start defining the layer 2 2024-06-08 11:34:52 +02:00
Thomas Kolb fe5bcabd14 doc: document burst format 2024-06-08 11:34:52 +02:00
Thomas Kolb be0cac13c1 Starting to write the documentation with AsciiDoc 2024-06-08 11:34:52 +02:00