diff options
| author | Přemysl Eric Janouch <p@janouch.name> | 2022-10-04 01:45:34 +0200 |
|---|---|---|
| committer | Přemysl Eric Janouch <p@janouch.name> | 2022-10-04 01:46:41 +0200 |
| commit | cbeb4e31336fc6562ef4cfa782051b610d8e2198 (patch) | |
| tree | 1f0ff547c54b926fca9f532fe529857df97f1595 | |
| parent | 0f3ed1457571ff8c42fc99e77ea18854afa877b0 (diff) | |
| download | liberty-cbeb4e31336fc6562ef4cfa782051b610d8e2198.tar.gz liberty-cbeb4e31336fc6562ef4cfa782051b610d8e2198.tar.xz liberty-cbeb4e31336fc6562ef4cfa782051b610d8e2198.zip | |
Improve documentation
| -rw-r--r-- | README.adoc | 15 | ||||
| -rw-r--r-- | libertyxdr.adoc | 2 |
2 files changed, 9 insertions, 8 deletions
diff --git a/README.adoc b/README.adoc index 5a3fd0b..69b036a 100644 --- a/README.adoc +++ b/README.adoc @@ -1,21 +1,22 @@ liberty ======= -'liberty' is a pseudolibrary of all the common C code I have written for various -projects. I used to copy-paste large swaths of code with minimal changes to it +'liberty' is a pseudolibrary largely consisting of reusable C code for my +various projects. I used to copy-paste large swaths of it with minimal changes, and it slowly became awfully painful to synchronize. The project can be thought of as a successor to my other C library, libxtnd. You are supposed to import it as a git submodule and include the main source -file directly everywhere you need it. Everything is declared "static". I have -come to the conclusion that this style of C programming suits me the best, as it -allows me to nearly forget about the mess that are header files. +file directly everywhere you need it, setting feature flags as appropriate. +Everything is declared "static". I have come to the conclusion that this style +of C programming suits me the best, as it allows me to nearly forget about the +mess that are header files. The API is intentionally unstable, which allows for easy refactoring. All development is done on Linux, but other POSIX-compatible operating systems -should be supported as well. They have an extremely low priority, however, and -I'm not testing them at all, with the exception of OpenBSD. +should be generally supported as well. They have an extremely low priority, +however, and I'm not testing them at all, perhaps with the exception of macOS. Tools ----- diff --git a/libertyxdr.adoc b/libertyxdr.adoc index 12b7e07..d3255ed 100644 --- a/libertyxdr.adoc +++ b/libertyxdr.adoc @@ -9,7 +9,7 @@ LibertyXDR - an XDR-derived IDL and data serialization format Description ----------- *LibertyXDR* is an interface description language, as well as a data -serialization format, that has been largely derived from XDR, though notably +serialization format. It is largely derived from XDR, though notably simplified. Conventions |