1414codeforge
/
df-serialize
mirror of https://codeberg.org/1414codeforge/df-serialize.git
1
0
Fork 0
Code Packages Projects Releases Activity

[README] Update library name, improve ldoc documentation.

This commit is contained in:
Lorenzo Cogotti 2022-08-10 09:25:47 +02:00
parent 523995e41b
commit 4fd9934232
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,7 +1,7 @@
serialize - A brainless Lua table serializer df-serialize - A brainless Lua table serializer
============================================ ============================================
**serialize** provides two functions: **df-serialize** provides two functions:
* `pack()` packs Lua tables to string. * `pack()` packs Lua tables to string.
* `unpack()` unpacks a string back to a Lua table. * `unpack()` unpacks a string back to a Lua table.
@ -9,7 +9,7 @@ serialize - A brainless Lua table serializer
The implementation strives to be useful under the majority of reasonable use cases, The implementation strives to be useful under the majority of reasonable use cases,
to be compact, understandable and sufficiently fast. to be compact, understandable and sufficiently fast.
There is no pretense of complete generality, nor of absolute efficiency. There is no pretense of complete generality, nor of absolute efficiency.
In case **serialize** does not meet exactly your requirements, the code In case **df-serialize** does not exactly meet your requirements, its code
should be immediate enough to tweak to your needs. should be immediate enough to tweak to your needs.
Documentation Documentation
@ -23,6 +23,10 @@ Documentation may be generated running the command:
ldoc init.lua ldoc init.lua
``` ```
`ldoc` generates a `doc` directory, open `doc/index.html`
with your favorite browser to read the documentation.
Test suite Test suite
========== ==========