p
/
liberty
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve documentation

This commit is contained in:
Přemysl Eric Janouch 2022-10-04 01:45:34 +02:00
parent 0f3ed14575
commit cbeb4e3133
Signed by: p
GPG Key ID: A0420B94F92B9493
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.adoc
View File

@ -1,21 +1,22 @@
liberty liberty
======= =======
'liberty' is a pseudolibrary of all the common C code I have written for various 'liberty' is a pseudolibrary largely consisting of reusable C code for my
projects. I used to copy-paste large swaths of code with minimal changes to it 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 and it slowly became awfully painful to synchronize. The project can be thought
of as a successor to my other C library, libxtnd. 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 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 file directly everywhere you need it, setting feature flags as appropriate.
come to the conclusion that this style of C programming suits me the best, as it Everything is declared "static". I have come to the conclusion that this style
allows me to nearly forget about the mess that are header files. 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. The API is intentionally unstable, which allows for easy refactoring.
All development is done on Linux, but other POSIX-compatible operating systems 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 should be generally supported as well. They have an extremely low priority,
I'm not testing them at all, with the exception of OpenBSD. however, and I'm not testing them at all, perhaps with the exception of macOS.
Tools Tools
----- -----

2
libertyxdr.adoc
View File

@ -9,7 +9,7 @@ LibertyXDR - an XDR-derived IDL and data serialization format
Description Description
----------- -----------
*LibertyXDR* is an interface description language, as well as a data *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. simplified.
Conventions Conventions