From 98098ba86e4946f66292cbf6729a875f44f3ef50 Mon Sep 17 00:00:00 2001 From: yueh Date: Sat, 13 Dec 2014 01:26:10 +0100 Subject: [PATCH] Merged api and lang READMEs --- README.md | 51 ++++++++++++++++++- src/api/java/appeng/api/README.md | 19 ------- .../assets/appliedenergistics2/lang/README.md | 24 --------- 3 files changed, 50 insertions(+), 44 deletions(-) delete mode 100644 src/api/java/appeng/api/README.md delete mode 100644 src/main/resources/assets/appliedenergistics2/lang/README.md diff --git a/README.md b/README.md index 2c0ae989f..77dd345ec 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ * [Issues](#issues) * [Building](#building) * [Contribution](#contribution) +* [API](#applied-energistics-2-api) +* [Localization](#applied-energistics-2-localization) * [Credits](#credits) ## About @@ -24,7 +26,12 @@ A Mod about Matter, Energy and using them to conquer the world.. ## License -Applied Energistics 2 is (c) 2013 - 2014 AlgorithmX2 and licensed under LGPL v3. See the LICENSE.txt for details or go to http://www.gnu.org/licenses/lgpl-3.0.txt for more information. Textures and Models are licensed under Creative Commons 3. +Applied Energistics 2 API is (c) 2013 - 2014 AlgorithmX2 and licensed under MIT. + +Applied Energistics 2 is (c) 2013 - 2014 AlgorithmX2 and licensed under LGPL v3. +See the LICENSE.txt for details or go to http://www.gnu.org/licenses/lgpl-3.0.txt for more information. + +Textures and Models are licensed under Creative Commons 3. ## Downloads @@ -97,6 +104,48 @@ Getting Started If you are only doing single file pull requests, GitHub supports using a quick way without the need of cloning your fork. Also read up about [synching](https://help.github.com/articles/syncing-a-fork) if you plan to contribute on regular basis. +## Applied Energistics 2 API + +The API for Applied Energistics 2. It is open source to discuss changes, improve documentation, and provide better add-on support in general. + +Development and standard builds can be obtained [Here](http://ae2.ae-mod.info/Downloads/). + +### Maven + +When compiling against the AE2 API you can use gradle dependencies, just add + +dependencies { + compile "appeng:appliedenergistics2:rv_-_____-__:dev" +} + +or add the compile line to your existing dependencies task to your build.gradle + +Where the __ are filled in with the correct version criteria; AE2 is available from the default forge maven so no additional repositories are necessary. + +## Applied Energistics 2 Localization + +### English Text + +en_US is included in this repository, fixes to typos are welcome, I AlgorithmX2 will mostly likely be one of the sole contributors to this file however. + +### Encoding + +Files must be encoded as UTF-8. + +### License + +All Text and Translations submitted here can be used for any purpose, and may be re-distributed or used without any limitations. + +### New Translations + +You can provide any additional languages by creating a new file with the appropriate language code. + +### Final Note + +If you have have issues localizing something feel free to contact me on IRC, at #AppliedEnergistics on Esper.net + +Thanks to everyone helping out to improve localization of AE2. + ## Credits Thanks to diff --git a/src/api/java/appeng/api/README.md b/src/api/java/appeng/api/README.md deleted file mode 100644 index 2c43544e6..000000000 --- a/src/api/java/appeng/api/README.md +++ /dev/null @@ -1,19 +0,0 @@ -Applied-Energistics-2-API -========================= - -The API for Applied Energistics 2. It is open source to discuss changes, improve documentation, and provide better add-on support in general. - -Development and standard builds can be obtained [Here](http://ae2.ae-mod.info/Downloads/). - -Maven -========================= - -When compiling against the AE2 API you can use gradle dependencies, just add - -dependencies { - compile "appeng:appliedenergistics2:rv_-_____-__:dev" -} - -or add the compile line to your existing dependencies task to your build.gradle - -Where the __ are filled in with the correct version criteria; AE2 is available from the default forge maven so no additional repositories are necessary. diff --git a/src/main/resources/assets/appliedenergistics2/lang/README.md b/src/main/resources/assets/appliedenergistics2/lang/README.md deleted file mode 100644 index b45159494..000000000 --- a/src/main/resources/assets/appliedenergistics2/lang/README.md +++ /dev/null @@ -1,24 +0,0 @@ -Applied Energistics 2 Localization -================================================== - -### English Text - -en_US is included in this repository, fixes to typos are welcome, I AlgorithmX2 will mostly likely be one of the sole contributors to this file however. - -### Encoding - -Files must be encoded as UTF-8. - -### License - -All Text and Translations submitted here can be used for any purpose, and may be re-distributed or used without any limitations. - -### New Translations - -You can provide any additional languages by creating a new file with the appropriate language code. - -### Final Note - -If you have have issues localizing something feel free to contact me on IRC, at #AppliedEnergistics on Esper.net - -Thanks to everyone helping out to improve localization of AE2. \ No newline at end of file