summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 221d56d..c77883a 100644
--- a/README.md
+++ b/README.md
@@ -52,8 +52,11 @@ no flags to get them:
`simd.h` states the rules for a new kernel.
-- `term.h` is the only header a host includes. It includes
- `term_input.h` and `term_types.h`. It compiles as C11 and as C++.
+- `term.h` is the only header a host includes. A host writes
+ `#include <term/term.h>`. The package adds only the include directory,
+ so `term.h` from another library, such as ncurses, is not shadowed. The
+ header includes `term_input.h` and `term_types.h`. It compiles as C11
+ and as C++.
- Every global symbol starts with `term_`. The library builds with hidden
symbols, so a shared build exports only the `TERM_API` functions of
`term.h`. `term-symbols-test` checks both.