Skip to content

Commit

Permalink
Minor documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
rafael-santiago committed Sep 9, 2023
1 parent 3ed0ced commit 53b6c00
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,6 @@ also instruct people about network security issues by using this software showin
the attacks proposed here. Use it as a classroom lab tool, too. Well, spread your knowledge! Thank you!

**Obvious but always good to remember**: all opinions expressed here are my own and not the views of my employers.

**Last but not least**: I do not provide pre-builts, if you have found any pre-built of ``macgonuts`` somewhere,
I **do not** endorse it.
3 changes: 3 additions & 0 deletions doc/Codingstyle.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ as 8 spaces, maybe due to a different "base" of Truth...).

4. Yes, ``80`` columns is such a really short limit, try not to exceed ``120``!

5. Use ``UNIX`` format (I meant line endings...) for all files, avoid ``DOS`` format. Try to find out how to deal with it
by using ``git`` or use ``dos2unix`` tool, but do not push ``DOS`` formatted files, please. Thanks! :wink:

## Header files

1. Header files have to start with a copyright disclaimer (that you can get from ``macgonuts_types.h``, for example).
Expand Down

0 comments on commit 53b6c00

Please sign in to comment.