Updated README for packaging and filesystem updates
This commit is contained in:
17
README.md
17
README.md
@@ -10,10 +10,16 @@ You can download LoveDOS from the
|
|||||||
using DOS as your operating system then [DOSbox](http://www.dosbox.com/) can be
|
using DOS as your operating system then [DOSbox](http://www.dosbox.com/) can be
|
||||||
used to emulate a DOS computer.
|
used to emulate a DOS computer.
|
||||||
|
|
||||||
When you run love.exe it searches for a file named "main.lua" in its current
|
When you run `love.exe` it will expect its first argument to be your game's
|
||||||
folder; the code in "main.lua" is then loaded and executed. A small example
|
directory. The file `main.lua` will then be searched for and executed. If, for
|
||||||
program which displays white text on a black background and exits when the
|
example, your project was in a directory named `mygame` you would run the
|
||||||
`escape` key is pressed is as follows:
|
following:
|
||||||
|
```batch
|
||||||
|
love mygame
|
||||||
|
```
|
||||||
|
|
||||||
|
A small example program which displays white text on a black background and
|
||||||
|
exits when the `escape` key is pressed is as follows:
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
function love.draw()
|
function love.draw()
|
||||||
@@ -30,6 +36,9 @@ end
|
|||||||
The [doc/api.md](doc/api.md) file provides a reference and overview of all of
|
The [doc/api.md](doc/api.md) file provides a reference and overview of all of
|
||||||
the built-in LoveDOS modules, functions and callbacks.
|
the built-in LoveDOS modules, functions and callbacks.
|
||||||
|
|
||||||
|
The [doc/packaging.md](doc/packaging.md) file provides instructions for
|
||||||
|
packaging your game for distribution.
|
||||||
|
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
Instructions for building the project from source can be found in the
|
Instructions for building the project from source can be found in the
|
||||||
|
|||||||
Reference in New Issue
Block a user