LovePackaging/README.md

47 lines
1.9 KiB
Markdown
Raw Normal View History

2014-11-11 06:28:02 +00:00
LovePackaging
=============
Scripts to create Love2d packages.
2014-11-11 08:12:52 +00:00
2014-11-26 02:51:39 +00:00
Currently working in Linux, untested in OS X (though it should work assuming you
have wget installed), and undeveloped for Windows.
Features
--------
- Builds executables for distribution on Windows, Mac, and Linux.
- Supports including extra files automatically.
2014-12-30 05:29:36 +00:00
- Can automatically number builds.
- Supports loading a specified config file.
(Note: Must be called from its own directory, but can access a config file from anywhere relative to there.)
2014-11-11 08:12:52 +00:00
Installation
------------
2014-12-30 05:29:36 +00:00
(Note that this guide may differ from the one in the latest release, refer to the ReadMe there for 100% correct info!)
2014-11-20 20:36:06 +00:00
Quick Guide:
1. Download the [latest release](https://github.com/Guard13007/LovePackaging/releases)!
2014-11-20 03:11:07 +00:00
2. Copy the files wherever you want, inside your own repo, outside, wherever!
2014-11-20 20:36:06 +00:00
3. Edit `config.sh` to specify options on how your packages will be built, including where the sources are and where to put the result.
4. Run `./build` for Linux / Mac OS X (OSX users need wget installed!!).
No Windows version yet, sorry.
2014-11-11 08:12:52 +00:00
2014-12-30 05:29:36 +00:00
A quick note to mention: The build script must be run from its own directory. Everything in the config.sh should be absolute directories. If specifying a custom config script, the path must be a relative path to where the build script is located. This is kinda shitty, but I am kinda shitty, sorry.
2014-11-11 08:18:21 +00:00
Contributing
------------
If you have any ideas or feature requests or bugfixes, please do create
issues, forks, pull requests, whatever. If there's something that be
done to make this better, I want to know about it!
2014-11-11 08:12:52 +00:00
Troubleshooting
---------------
2014-11-27 18:27:20 +00:00
Feel free to submit an issue for any problem you have, also check [the forum](https://love2d.org/forums/viewtopic.php?f=4&t=79155&sid=2dfd50989af78c87dc75a9558e1ffb08) post for help.
2014-11-11 08:12:52 +00:00
Screenshots are great if you're reporting a problem. But in any case, common
problems listed below, all one of them!