README - First draft of a Readme

Need to improve it a lot
This commit is contained in:
BarbzYHOOL
2018-05-14 23:51:14 +02:00
parent 7a24b47d76
commit 9a9c910235

51
README.md Normal file
View File

@@ -0,0 +1,51 @@
# PART 1 - Explanation on how to create your own module with
TODO
-------------------------------------------------------
# PART 2 - EXAMPLE OF A README.md
# MY NEW MODULE (title)
## Description
This module allows to do this and this.
## How to use ingame
Do this and that.
## Requirements
My new module requires:
- AzerothCore v1.0.1+
## Installation
1) Simply place the module under the `modules` directory of your AzerothCore source.
2) Import the SQL manually or with the `db_assembler.sh` (if `include.sh` provided)
3) Re-run cmake and launch a clean build of AzerothCore.
## Edit module configuration (Optional)
If you need to change the module configuration, go to your server configuration folder (where your `worldserver` or `worldserver.exe` is), copy `my_module.conf.dist` to `my_module.conf` and edit that new file.
## Credits
Me (author of the module): Check out my soundcloud - Join my discord
Barbz: best guy
Talamortis: almost best guy
AzerothCore: [repository](https://github.com/azerothcore) - [website](http://azerothcore.org/) - [discord chat community](https://discord.gg/PaqQRkd)