Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/WolfireGames/overgrowth.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLukas Orsvärn <lukas@orsvarn.com>2022-03-10 15:37:32 +0300
committerMax Danielsson <max@autious.net>2022-04-12 14:25:53 +0300
commit82137f4e41a240ccaf2312af250a441a0c0ebef7 (patch)
treee86fdd0ecc3364a2392209d240eca73153c8aba3 /README.md
parent526bbffa9f92bdb3f4da8c1d620d6077567711c2 (diff)
Add Compiling, Contribution and Readme files
Diffstat (limited to 'README.md')
-rw-r--r--README.md55
1 files changed, 53 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7c6b24e4..61956972 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,53 @@
-# overgrowth
-Open Source codebase of the game Overgrowth by Wolfire Games LLC
+# Overgrowth
+This is the official repository for [Overgrowth]'s source code. Only the code is available here; the game data (such as art assets and levels) can only be legally obtained by purchasing Overgrowth from [Wolfire Games].
+
+This repository lets you‥
+
+- Run the open source code with the commercial data to perform experiments for educational purposes.
+- Propose changes to be merged back into the commercial game.
+- Create modifications for Overgrowth that would otherwise be impossible.
+- Use helpful code snippets in your projects.
+- Create your own commercial "total conversions" that use an entirely new set of assets.
+
+If you would like to distribute any of the original Overgrowth assets, you must obtain explicit written permission from Wolfire Games.
+
+## Compiling
+[COMPILING.md] contains instructions on compiling and running the commercial Overgrowth game using the open source code.
+
+## Contributing
+This repository is entirely community-operated. This means you can help by submitting bug reports, reviewing other people's code, contributing your own code, and so on.
+
+Read [CONTRIBUTING.md] for more information.
+
+## License
+Unless otherwise noted, the code in this repository is licensed under `Apache-2.0`. Read [LICENSE] for the full license.
+
+`Apache-2.0` is a "permissive" open source license, meaning you can use it for more or less whatever you want, including in closed source projects. Licenses are hard to understand, `Apache-2.0` is no exception. Here is a summary of what the license means in practice in most cases. This is not legal advice:
+
+If you distribute a compiled program using the code, or you distribute the code itself, modified or not, you must do the following:
+
+### Include the entire contents of the `LICENSE` file
+
+The license can be somewhere in the program itself or in a separate file. The purpose is to clarify under what license you're using the code. For example, you can have a file called `LICENSES`, and there you can have a line saying `This software uses code from Overgrowth under the Apache-2.0 license, read the full license in the file named LICENSE_APACHE.`.
+
+### Mark files you've changed with a notice
+
+If you distribute the code itself, in each file you modify, write that you have modified it. For instance, the files have a "boilerplate notice" at the top, you can write that you have changed it there, so it looks something like this:
+
+```
+// Name: filename.h
+// Developer: Wolfire Games LLC
+// Modified By: Firstname Lastname
+// Description:
+// License: Read below
+```
+
+### Do not remove any copyright notices or similar
+
+You're not allowed to remove things like `Copyright 2022 Company Name` or similar.
+
+[Overgrowth]: https://overgrowth.wolfire.com
+[Wolfire Games]: https://wolfire.com
+[COMPILING.md]: COMPILING.md
+[CONTRIBUTING.md]: CONTRIBUTING.md
+[LICENSE]: LICENSE