README.md: added

This commit is contained in:
Nikos Mavrogiannopoulos 2017-03-28 14:18:16 +02:00
parent 48d061b77e
commit 2f541f9e5a

View file

@ -1,14 +1,14 @@
TODO and bug tracking
---------------------
# Security coding guide
The secure-coding guide has its own component in Bugzilla:
This is a fork of the Fedora secure coding guide.
https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora%20Documentation&component=defensive-coding-guide
The guide is present in HTML form (auto-generated from this
repository) at:
Please file bugs and suggestions there.
* http://redhat-sectech.gitlab.io/defensive-coding-guide
Building HTML documentation
---------------------------
# Building HTML documentation
Just type "make". If you do not want to build the example code, run
"make build-manual".
@ -19,8 +19,9 @@ 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 needs the "publican" and the "publican-fedora"
# Dependencies
Building the manual pages needs the "publican" and the "publican-fedora"
packages.