Browse Source

Improve README.

tags/v0.1
Starbeamrainbowlabs 3 years ago
parent
commit
4bf87914ce
1 changed files with 12 additions and 1 deletions
  1. 12
    1
      README.md

+ 12
- 1
README.md View File

@@ -1,3 +1,14 @@
# SpritePacker

An advanced sprite packing tool. Currently work in progress.
An advanced sprite packing tool. Currently a work in progress.

## Getting Started
* Clone or download this repo, and build the included solution.
* Windows GUI: Open the solution in Visual Studio and hit build (CTRL + SHIFT + B).
* Windows Command Line: Run `msbuild` from the root of this repo (I assume).
* Linux GUI: Open the solution in MonoDevelop and hit build (F8)
* Linux Command Line: Run `xbuild` from the root of this repo.
* Run `./SpritePacker.exe --help` to learn how to use it.

## License
This tool is licensed under the Mozilla Public License version 2.0. You can view the full license text in the `LICENSE` file in this repo. Alternatively, [tl;dr legal](https://tldrlegal.com/) has a [summary](https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)) of this license.

Loading…
Cancel
Save