Fixed up the docs.
This commit is contained in:
35
README.md
Normal file
35
README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
Cambridge
|
||||
=========
|
||||
|
||||
Welcome to Cambridge, the next open-source falling-block game engine!
|
||||
|
||||
|
||||
Installation instructions
|
||||
-------------------------
|
||||
|
||||
Pre-built releases are available on the releases page.
|
||||
|
||||
### Windows
|
||||
|
||||
Unzip the exe file and run it directly. All assets are currently bundled inside the executable.
|
||||
|
||||
### macOS
|
||||
|
||||
For the time being, the file `cambridge.love` only works on the command line. Install `love` with [https://brew.sh/](Homebrew), and run:
|
||||
|
||||
$ love cambridge.love
|
||||
|
||||
### Linux
|
||||
|
||||
Same as macOS, except use your favourite package manager.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
The Cambridge project is licensed under the MIT license (included in LICENSE.md).
|
||||
|
||||
Some code and assets in this repository are contributed by members of the
|
||||
community, as well as borrowed from other places, either with licensing
|
||||
or as placeholders until suitable material can be found that is properly
|
||||
licensed. Their original sources, and copyright notices if applicable, are
|
||||
listed in the file SOURCES.
|
||||
Reference in New Issue
Block a user