Update and rename README.txt to README.md

master
Brett O'Donnell 2014-01-16 20:37:58 +10:30
parent 3b965bda48
commit 8a1a54e754
2 changed files with 42 additions and 40 deletions

42
README.md Normal file
View File

@ -0,0 +1,42 @@
# Towntest for Minetest
Grow a town in minetest.
## Features
- chest that allows you to choose a building, then you fill the chest with required items and an NPC will build the building more buildings can be added to the buildings folder and will be automatically added in the game
- coming one-day - more NPCs - miners, lumberjacks, crafters
## Resources
- **[Documentation](http://cornernote.github.io/minetest-towntest)**
- **[GitHub Project](https://github.com/cornernote/minetest-towntest)**
- **[Minetest Forum](http://minetest.net/forum/viewtopic.php?id=3223)**
## Support
- Does this README need improvement? Go ahead and [suggest a change](https://github.com/cornernote/minetest-towntest/edit/master/README.md).
- Found a bug, or need help using this project? Check the [open issues](https://github.com/cornernote/minetest-towntest/issues) or [create an issue](https://github.com/cornernote/minetest-towntest/issues/new).
## About
This module is open source, so it's distributed freely. If you find it useful then I ask not for your wealth, but simply to spare your time to consider the world we share by watching [Earthlings](http://earthlings.com/), a multi-award winning film available to watch online for free. A must-see for anyone who wishes to make the world a better place.
## Credits
- PilzAdam - made the initial NPC entity movement code
- VanessaE - contributed buildings
- kddekadenz - contributed buildings
- ACDC - contributed buildings
- Nanuk - contributed buildings
- irksomeduck - contributed buildings
## License
[BSD-3-Clause](https://raw.github.com/cornernote/minetest-towntest/master/LICENSE), Copyright © 2013-2014 [Brett O'Donnell](http://cornernote.github.io/)

View File

@ -1,40 +0,0 @@
----------------------------------
Towntest for Minetest
----------------------------------
Copyright (c) 2012 cornernote, Brett O'Donnell <cornernote@gmail.com>
Source Code: https://github.com/cornernote/minetest-towntest
Home Page: https://sites.google.com/site/cornernote/minetest/towntest
Contributors:
PilzAdam - made the initial NPC entity movement code
VanessaE - contributed buildings
kddekadenz - contributed buildings
ACDC - contributed buildings
Nanuk - contributed buildings
irksomeduck - contributed buildings
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
----------------------------------
Description
----------------------------------
Grow a Town in Minetest.
Current features:
Chest
chest that allows you to choose a building, then you fill the chest with required items and an NPC will build the building
more buildings can be added to the buildings folder and will be automatically added in the game
Future features:
- more NPCs - miners, lumberjacks, crafters