diff --git a/README.md b/README.md index 033b0ef..20e3427 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # Reapi [![Build Status](http://teamcity.rehlds.org/app/rest/builds/buildType:(id:Reapi_Publish)/statusIcon)](http://teamcity.rehlds.org/viewType.html?buildTypeId=Reapi_Publish&guest=1) [![Download](https://camo.githubusercontent.com/a3ac64aab91dcea4e0f3dfd611808ad61cc05798/687474703a2f2f7265686c64732e6f72672f76657273696f6e2f72656170692e737667)](http://teamcity.rehlds.org/guestAuth/downloadArtifacts.html?buildTypeId=Reapi_Publish&buildId=lastSuccessful) AMX Mod X module, using API regamedll & rehlds + +## Build instructions +There are several software requirements for building ReAPI: +
    +
  1. Java Development Kit (JDK) 7+ (http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
  2. +
  3. For Windows: Visual Studio 2015 and later
  4. +
  5. For Linux: Intel C++ Compiler 15 and later
  6. +
+ +### Checking requirements +#### JDK version +Windows
> %JAVA_HOME%\bin\javac -version
+javac 1.8.0_25
+
+ +Linux +
$ javac -version
+javac 1.7.0_65
+
+ +#### Visual Studio +Help -> About + +#### ICC +
$ icc --version
+icc (ICC) 15.0.1 20141023
+
+ +### Building +On Windows: +
gradlew clean buildRelease
+ +On Linux (ICC): +
./gradlew clean buildRelease
+ +On Linux (GCC): +
./gradlew clean -PuseGcc buildRelease
+ +Compiled binaries will be placed in the build/binaries/ directory + +## How can I help the project? +Just install it on your game server and report problems you faced.
+Merge requests are also welcome :shipit: