From a70b76bf071c34692bac99da252a3c74a355db71 Mon Sep 17 00:00:00 2001
From: amelia <amelia@no-reply@disroot.org>
Date: Fri, 23 Feb 2024 19:51:22 +0000
Subject: docs readme

---
 docs/readme.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 docs/readme.md

(limited to 'docs/readme.md')

diff --git a/docs/readme.md b/docs/readme.md
new file mode 100644
index 0000000..18deebf
--- /dev/null
+++ b/docs/readme.md
@@ -0,0 +1,24 @@
+# lualib (llib) 
+(name subject to change)
+
+with the library in the same directory [(or one of the other valid search locations)](https://www.lua.org/pil/8.1.html)
+
+```lua
+require "llib"
+```
+
+which makes a global llib table
+
+> ### future require versions will eventually return the table
+> ```lua
+> llib = require "llib"
+> ```
+
+the table has many subtables, with related function in them, you can view them like so
+
+```lua
+llib.io.pprint(llib) --pprint is a part of the io module, pprint meaning pretty print
+```
+
+all subtables have a corresponding file in this directory, with info on its functions
+
-- 
cgit v1.2.3