summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Ipsum <richardipsum@fastmail.co.uk>2017-05-08 13:22:31 +0100
committerRichard Ipsum <richardipsum@fastmail.co.uk>2017-05-08 23:52:11 +0100
commitdde17e0715ddc4a4bb28fd1e842467a489a16341 (patch)
tree063508966d4681b3b2aaab495a6d50a02f6010ac
parent28060bb52dd75c398ee90a8ab679a024814f4441 (diff)
downloadluxio-dde17e0715ddc4a4bb28fd1e842467a489a16341.tar.gz
README: Add new optional step: install docs
-rw-r--r--README13
1 files changed, 7 insertions, 6 deletions
diff --git a/README b/README
index b496d17..cd1aaa7 100644
--- a/README
+++ b/README
@@ -2,8 +2,8 @@ Luxio - Lightweight UNIX I/O and POSIX binding for Lua
------------------------------------------------------
Now:
- 0. Supports Lua 5.1 and Lua 5.2.
- 1. Reasonably good coverage of POSIX and BSD Sockets, including IPv6,
+ 0. Supports Lua 5.1 and Lua 5.2.
+ 1. Reasonably good coverage of POSIX and BSD Sockets, including IPv6,
and some GNU extensions.
2. Meant to be buildable anywhere that is POSIX.1-1996. If it's not,
there's a bug. These are likely, as I have nowhere other than
@@ -13,10 +13,10 @@ Now:
may return tables.
4. High-level wrapper library providing nice IO access and to misc.
utility functions. Generates useful errors in assert()able form,
- and provides meaningful __tostring metamethods to aid debugging.
+ and provides meaningful __tostring metamethods to aid debugging.
5. A high-level poll()-based event dispatch library.
6. Sub-process handling library (read/write io.popen with job control).
- 7. A prototype POSIX Message Queue-based IPC scheme that can serialise
+ 7. A prototype POSIX Message Queue-based IPC scheme that can serialise
most simple Lua values. (No closures, userdata, etc)
8. Liberal licence. (Same as Lua's. See the file LICENCE.)
@@ -24,9 +24,10 @@ Future:
0. Well-documented.
1. Well-tested.
2. Complete POSIX coverage (where appropriate).
- 3. Better socketing, specifically for datagram sockets.
- 4. Advanced features like file descriptor passing.
+ 3. Better socketing, specifically for datagram sockets.
+ 4. Advanced features like file descriptor passing.
How to build:
0. Type "make".
1. Optionally, type "make install".
+ 2. Optionally, type "make install-doc"