README.md: added
This commit is contained in:
parent
48d061b77e
commit
2f541f9e5a
1 changed files with 11 additions and 10 deletions
27
README.md
Normal file
27
README.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
# Security coding guide
|
||||
|
||||
This is a fork of the Fedora secure coding guide.
|
||||
|
||||
The guide is present in HTML form (auto-generated from this
|
||||
repository) at:
|
||||
|
||||
* http://redhat-sectech.gitlab.io/defensive-coding-guide
|
||||
|
||||
|
||||
# Building HTML documentation
|
||||
|
||||
Just type "make". If you do not want to build the example code, run
|
||||
"make build-manual".
|
||||
|
||||
When you type "make", the code examples in src/ are compiled (mainly
|
||||
to check for obvious syntax errors, but also for manual testing). If
|
||||
you lack the necessary libraries, you can type "make build-manual"
|
||||
instead, which will skip this step. The code examples are still
|
||||
included in the manual.
|
||||
|
||||
|
||||
# Dependencies
|
||||
|
||||
Building the manual pages needs the "publican" and the "publican-fedora"
|
||||
packages.
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue