aboutsummaryrefslogtreecommitdiff
path: root/readme
diff options
context:
space:
mode:
authorAleksey Veresov <aleksey@veresov.pro>2020-02-21 18:09:22 +0300
committerAleksey Veresov <aleksey@veresov.pro>2020-02-21 18:09:22 +0300
commita93c561921b79e5f27b986292fe70dce1879f91e (patch)
treee28853c5196344ac80f5ad04d16bab673733f499 /readme
parent83cd2267b309fa7411acaed356f88101196bb2ad (diff)
downloadmagi-a93c561921b79e5f27b986292fe70dce1879f91e.tar
magi-a93c561921b79e5f27b986292fe70dce1879f91e.tar.xz
magi-a93c561921b79e5f27b986292fe70dce1879f91e.zip
[magi]
Diffstat (limited to 'readme')
-rw-r--r--readme9
1 files changed, 5 insertions, 4 deletions
diff --git a/readme b/readme
index fb36636..3160155 100644
--- a/readme
+++ b/readme
@@ -4,11 +4,12 @@ Magi Library (libmagi) implements Gateway Interfaces, namely CGI and FastCGI.
Overview
Magi are free and open-source software: legal info is in the 'license' file.
They are written in ANSI C, without any dependecies, except for C standard
-library. All source and header files are located in the 'src' directory.
+library. All source and inner header files are located in the 'src' directory.
The 'include' directory is intended to be used in your include environment.
-Headers themselves are in 'magi' subdirectory of include, due to their short
-and simple names. If you are not about choosing which header to include and
-just want everything to be included you can use 'magi.h'.
+Headers in it contain library interface and its documentation in comments.
+They are in subdirectory 'include/magi', due to their short and simple names.
+If you are not about choosing which header to include and just want everything
+to be included you can '#include <magi.h>'.
Compiling
Compilation and its options are described in the 'Makefile'.