mirror of
https://github.com/TangentFoxy/lovebird.git
synced 2025-07-28 11:02:19 +00:00
Made minor tweaks and added source links to README.md
This commit is contained in:
@@ -3,8 +3,8 @@ A debug console for [LÖVE](http://love2d.org) which runs in the browser.
|
|||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Drop the [lovebird.lua](#) file into an existing project and place the
|
Drop the [lovebird.lua](lovebird.lua?raw=1) file into an existing project and
|
||||||
following line at the top of your `love.update()` function:
|
place the following line at the top of your `love.update()` function:
|
||||||
```lua
|
```lua
|
||||||
require("lovebird").update()
|
require("lovebird").update()
|
||||||
```
|
```
|
||||||
@@ -23,7 +23,7 @@ a variable when it is required:
|
|||||||
```lua
|
```lua
|
||||||
lovebird = require "lovebird"
|
lovebird = require "lovebird"
|
||||||
```
|
```
|
||||||
Any configuration variables should be set before lovebird.update()` is called.
|
Any configuration variables should be set before `lovebird.update()` is called.
|
||||||
|
|
||||||
### lovebird.port
|
### lovebird.port
|
||||||
The port which lovebird listens for connections on. By default this is `8000`
|
The port which lovebird listens for connections on. By default this is `8000`
|
||||||
@@ -49,7 +49,7 @@ This is `0.5` by default.
|
|||||||
|
|
||||||
### lovebird.page
|
### lovebird.page
|
||||||
The HTML page template which is used when lovebird is accessed by the browser.
|
The HTML page template which is used when lovebird is accessed by the browser.
|
||||||
The default is too long to list here, see [lovebird.lua](#).
|
The default is too long to list here, see [lovebird.lua](lovebird.lua).
|
||||||
|
|
||||||
### lovebird.print(...)
|
### lovebird.print(...)
|
||||||
Prints its arguments to lovebird's console. If `lovebird.wrapprint` is set to
|
Prints its arguments to lovebird's console. If `lovebird.wrapprint` is set to
|
||||||
|
Reference in New Issue
Block a user