From bdd09d641da65087ef12227e0bc2486a321a0c46 Mon Sep 17 00:00:00 2001 From: orwell96 Date: Thu, 14 Jun 2018 18:31:26 +0200 Subject: Readme as markdown, add contributing.md --- contributing.md | 32 ++++++++++++++++++++++++++++++++ readme.md | 36 ++++++++++++++++++++++++++++++++++++ readme.txt | 36 ------------------------------------ 3 files changed, 68 insertions(+), 36 deletions(-) create mode 100644 contributing.md create mode 100644 readme.md delete mode 100644 readme.txt diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..5d649c0 --- /dev/null +++ b/contributing.md @@ -0,0 +1,32 @@ + +## Advtrains contribution guide + +advtrains is an Open Source project, and as such lives from contributions of various people, may it be reporting of bugs, submittting patches or translating (translating is not applicable at the moment because I did rarely mark strings). + +If you have found a bug or have a feature request, you can open a bug ticket at this issue tracker: +http://mantis.bleipb.de/ + +### Contributing code +If you want to contribute code, such as fixing a bug or implementing a feature, do one the following: +**If you have a public git repository:** +1. Clone this repository and push it to your own public git repo. +2. implement your change +3. push your changes there + +**If not:** +4. Clone this repository to your computer +5. implement your change +6. use `git format-patch ` to generate patch files. +``` +$ git format-patch master +0001-Fix-bug-foo.patch +0002-Correct-something.patch +``` +**You then have 3 options:** +7. If your contribution is a fix to a bug that has a Mantis ticket, attach your patch files/link to your public repo to this bug's ticket. +8. If not, create a new ticket, apply the tag "Patch/Pull Request", and attach your patch files/link to your public repo there, or +9. send your patch files/link to your public repo via e-mail to mailto:orwell@bleipb.de + +### Final note +Whenever you contribute something, I do my best to give you credit for your work. +If you have questions or other remarks, you can contact me via a [Minetest Forum PM](https://forum.minetest.net/ucp.php?i=pm&mode=compose&u=17391) diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..883fe6d --- /dev/null +++ b/readme.md @@ -0,0 +1,36 @@ + +## ADVTRAINS ## realistic trains in Minetest! +by orwell96 and contributors(see below) + +For up-to-date information, visit https://forum.minetest.net/viewtopic.php?f=9&t=14726 + + +Manual: +See manual.pdf (might not be up to date) +For information on LuaATC see the file inside the advtrains_luaautomation mod directory. + +License of code: LGPL 2.1 +License of media: CC-BY-SA 3.0 + +Contributions: + +Gravel Texture : from Minetest Game +Initial rail model/texture : DS-minetest +Models for signals/bumpers : mbb +Steam engine / wagon texture: mbb +Detailed Steam engine : mbb / Krokoschlange(animation) +Industrial engine/wagons : mbb +Inventory images : mbb +Small code contributions : NaruTrey +Major code contributions : gpcf +Mod Description : hajo +Sounds: +advtrains_crossing_bell : Codesound +advtrains_japan_horn : Codesound +advtrains_steam_whistle : googol +advtrains_subway_horn : https://freesound.org/people/Mullumbimby/sounds/385283/ +advtrains_subway_* : Gabriel (gbl08ma) + +If I forgot someone please punish me for that. + +You can see this mod in action on Linuxworks Next Generation server. diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 883fe6d..0000000 --- a/readme.txt +++ /dev/null @@ -1,36 +0,0 @@ - -## ADVTRAINS ## realistic trains in Minetest! -by orwell96 and contributors(see below) - -For up-to-date information, visit https://forum.minetest.net/viewtopic.php?f=9&t=14726 - - -Manual: -See manual.pdf (might not be up to date) -For information on LuaATC see the file inside the advtrains_luaautomation mod directory. - -License of code: LGPL 2.1 -License of media: CC-BY-SA 3.0 - -Contributions: - -Gravel Texture : from Minetest Game -Initial rail model/texture : DS-minetest -Models for signals/bumpers : mbb -Steam engine / wagon texture: mbb -Detailed Steam engine : mbb / Krokoschlange(animation) -Industrial engine/wagons : mbb -Inventory images : mbb -Small code contributions : NaruTrey -Major code contributions : gpcf -Mod Description : hajo -Sounds: -advtrains_crossing_bell : Codesound -advtrains_japan_horn : Codesound -advtrains_steam_whistle : googol -advtrains_subway_horn : https://freesound.org/people/Mullumbimby/sounds/385283/ -advtrains_subway_* : Gabriel (gbl08ma) - -If I forgot someone please punish me for that. - -You can see this mod in action on Linuxworks Next Generation server. -- cgit v1.2.3