Browse Source

update readme

Eduardo Bart 9 years ago
parent
commit
8494e25e62
1 changed files with 28 additions and 8 deletions
  1. 28
    8
      README.rdoc

+ 28
- 8
README.rdoc View File

@@ -7,17 +7,24 @@ that each functionality is a separated module, giving the possibility to users m
7 7
 anything easily. Users can also create new mods and extend game interface for their own purposes.
8 8
 OTClient is written in C++2011, the upcoming C++ standard.
9 9
 
10
-== Getting Started
10
+== Download
11
+
12
+Daily snapshots of otclient master branch compiled for Windows and protocol 860 is available
13
+in the {downloads section}[https://github.com/edubart/otclient/downloads] of the project github page.
14
+For any other platform or protocol you will need to compile the source code. Currently Linux/Windows
15
+platforms and protocols 860/861/862 is supported.
16
+
17
+== Compiling
11 18
 
12 19
 In short, if you need to compile OTClient, follow these tutorials:
13
-* {Compiling on Windows}[http://otclient.info/page/articles.html/_/general/compiling-on-windows-r9]
14
-* {Compiling on Ubuntu}[http://otclient.info/page/articles.html/_/general/compiling-on-ubuntu-r12]
15
-Checkout our website at {http://otclient.info}[http://otclient.info/] for tutorials and more information
20
+* {Compiling on Windows}[http://otclient.info/index.php?app=ccs&module=pages&section=pages&id=2&record=9]
21
+* {Compiling on Ubuntu}[http://otclient.info/index.php?app=ccs&module=pages&section=pages&id=2&record=12]
16 22
 
17 23
 == Need help?
18 24
 
25
+Checkout our website at {http://otclient.info}[http://otclient.info/] for tutorials and more information.
19 26
 If you have any questions or are looking for more information, please feel free to ask on our official
20
-forum at http://otclient.info
27
+forum at http://otclient.info or talk with us at #otclient irc.freenode.net
21 28
 
22 29
 == Bugs
23 30
 
@@ -29,12 +36,25 @@ http://otclient.info/tracker
29 36
 We encourage you to contribute to OTClient! Please check out
30 37
 {our website}[http://otclient.info/] for guidelines about how to proceed. Join us!
31 38
 
39
+We are currently needing help in the following areas:
40
+* Designing new UI themes or improving the current one
41
+* Translating the client to other languages
42
+* Documenting lua APIs and creating tutorials
43
+* Creating new modules in lua and improving the current ones
44
+* Spreading otclient project over the web and bring it to new possible contributors
45
+
32 46
 == Contact
33 47
 
34
-You have 3 options, use the forum at http://otclient.info/ , talk directly with us at #otclient irc.freenode.net or send
35
-an email directly to the project leader edub4rt@gmail.com
48
+You have 3 options, use the forum at http://otclient.info , talk directly with us at
49
+#otclient irc.freenode.net or send an email directly to the project leader edub4rt@gmail.com
36 50
 
37 51
 == License
38 52
 
39
-OTClient is made available under the MIT License, thus this means that you can do whatever you want, commercial, non-commercial, closed or open.
53
+OTClient is made available under the MIT License, thus this means that you are free
54
+to do whatever you want, commercial, non-commercial, closed or open.
55
+
56
+
57
+== Donate
40 58
 
59
+OTClient needs your support, if you really like and use it, please donate. We might prioritize features
60
+requests from who donate, in this case you can send an email to the project leader.

Loading…
Cancel
Save