Add a readme file

Add a basic readme file with information about the mod.

Also add the screenshot of the mod from the forum topic to the readme.
This commit is contained in:
Christopher Wells 2016-06-12 15:51:04 -04:00
parent 8dcd70d85c
commit 1d174c3e03
No known key found for this signature in database
GPG Key ID: AFE2DF9F8FFED2C4
2 changed files with 18 additions and 0 deletions

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# Maidroid
Maidroid is a mod for Minetest which adds maid robots that can perform common tasks such as farming and cutting down trees.
![A screenshot of maid robots from the Maidroid mod](screenshot_readme.png)
## Dependencies
* default
* dye
## Forum Topic
The forum topic for this mod on the Minetest Forums is located at:
* https://forum.minetest.net/viewtopic.php?f=9&t=14808
## License
The source code of Maidroid is available under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) or later license.
The resouces included in Maidroid are available under the [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) or later license.

BIN
screenshot_readme.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 181 KiB