Some README formatting changes

This commit is contained in:
Izaya 2017-04-19 22:52:17 +10:00
parent 8fe151cac3
commit a0c57e59a1

View File

@ -5,21 +5,21 @@
#### s(name,function,environment) #### s(name,function,environment)
Spawns a process from `function` under the name `name`, with the environment table specified in `environment`. Environment doesn't really have much use right now. Spawns a process from `function` under the name `name`, with the environment table specified in `environment`. Environment doesn't really have much use right now.
#### l() #### `l() `
Returns the last event. Doesn't actually work right now. Returns the last event. Doesn't actually work right now.
#### h(...) #### `h(...)`
Pushes an event to the queue, with whatever data you specify. Generally used for IPC. Pushes an event to the queue, with whatever data you specify. Generally used for IPC.
### Module APIs ### Module APIs
#### library/print.lua #### library/print.lua
These functions should be display device indepentent. These functions should be display device indepentent.
##### print(...) ##### `print(...)`
Displays its arguments on the display device as a string, with a newline. Displays its arguments on the display device as a string, with a newline.
##### write(...) ##### `write(...)`
Displays its arguments on the display device as a string, without a newline Displays its arguments on the display device as a string, without a newline
#### drivers/keyboard.lua #### drivers/keyboard.lua
This is a device-specific driver. This is a device-specific driver.
##### readln() ##### `readln()`
Reads a line of input from the keyboard. Reads a line of input from the keyboard.
#### library/net.lua #### library/net.lua
Note: Settings have to be set in the kernel module, at the line Note: Settings have to be set in the kernel module, at the line
@ -29,6 +29,6 @@ tM,nP,nID = {}, 4096, 1
Where 4096 is the port and 1 is the device ID. Device ID can be any data type, port must be a number. Where 4096 is the port and 1 is the device ID. Device ID can be any data type, port must be a number.
Network messages can be read from `_G.ev`, they have the type `net_msg` Network messages can be read from `_G.ev`, they have the type `net_msg`
##### ns(id,po,msg) ##### `ns(id,po,msg)`
Sends network message `msg` to device `id` on port `po` Sends network message `msg` to device `id` on port `po`