Browse Source

update readme

Eduardo Bart 9 years ago
parent
commit
9c986c4c5c
3 changed files with 26 additions and 8 deletions
  1. 0
    2
      AUTHORS
  2. 0
    2
      BUGS
  3. 26
    4
      README.rdoc

+ 0
- 2
AUTHORS View File

@@ -1,2 +0,0 @@
1
-edubart - leader developer    <edub4rt@gmail.com>
2
-baxnie  - developer           <henrique_santiago93@hotmail.com>

+ 0
- 2
BUGS View File

@@ -1,2 +0,0 @@
1
-To report bugs and see currently known bugs visit:
2
-https://github.com/edubart/otclient/issues

+ 26
- 4
README.rdoc View File

@@ -1,18 +1,40 @@
1
-== Welcome
2
-OTClient is an alternative tibia client for otserv written in C++2011, made
3
-with a modular system that uses lua scripts for ingame interface and
4
-functionality, making otclient flexible and easy to customize.
1
+== What is OTClient?
2
+
3
+OTClient is an alternative Tibia client for usage with otserv. It aims to be complete and flexible,
4
+for that it uses LUA scripting for all game interface functionality and configuration files created with
5
+a syntax similar to CSS for its interface design. OTClient works with a modular system, this means
6
+that each functionality is a separated module, giving the possibility to users modify and customize
7
+anything easily. Users can also create new mods and extend game interface for their own purposes.
8
+OTClient is written in C++2011, the upcoming C++ standard.
9
+
10
+== Need help?
11
+
12
+If you have any questions or are looking for more information, please feel free to ask on our official
13
+forum at http://otclient.info/
5 14
 
6 15
 == Getting Started
7 16
 
17
+In short, if you need to compile OTClient, follow these tutorials:
8 18
 * {Compiling on Windows}[http://otclient.info/page/articles.html/_/general/compiling-on-windows-r9]
9 19
 * {Compiling on Ubuntu}[http://otclient.info/page/articles.html/_/general/compiling-on-ubuntu-r12]
10 20
 Checkout our website at {http://otclient.info}[http://otclient.info/] for tutorials and more information
11 21
 
22
+== Bugs
23
+
24
+Have found a bug? Please create an issue in our bug tracker!
25
+http://otclient.info/tracker
26
+
12 27
 == Contributing
13 28
 
14 29
 We encourage you to contribute to OTClient! Please check out
15 30
 {our website}[http://otclient.info/] for guidelines about how to proceed. Join us!
16 31
 
32
+== Authors
33
+
34
+* edubart <edub4rt@gmail.com> (project creator and leader developer)
35
+* baxnie <henrique_santiago93@hotmail.com> (official developer)
36
+
17 37
 == License
38
+
18 39
 OTClient is made available under the MIT License
40
+

Loading…
Cancel
Save