aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnton Tananaev <anton.tananaev@gmail.com>2015-06-01 15:43:32 +1200
committerAnton Tananaev <anton.tananaev@gmail.com>2015-06-01 15:43:32 +1200
commitb0ff4b75ba21324964d31314e257f202d94416d4 (patch)
tree59bd32cde628c18b2731a300682218ed6dd8f583
parent0b575b94f469cdcdb24a6f86beee5e2c86285cb1 (diff)
downloadtraccar-server-b0ff4b75ba21324964d31314e257f202d94416d4.tar.gz
traccar-server-b0ff4b75ba21324964d31314e257f202d94416d4.tar.bz2
traccar-server-b0ff4b75ba21324964d31314e257f202d94416d4.zip
Add build instructions to readme
-rw-r--r--README.md29
-rw-r--r--README_MAVEN.txt42
-rw-r--r--README_SETUP.txt20
3 files changed, 28 insertions, 63 deletions
diff --git a/README.md b/README.md
index 4932e97dc..e41295ace 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,34 @@ Website - [https://www.traccar.org](https://www.traccar.org)
Traccar is open source server for various GPS tracking devices. Project is written in Java and works on most platforms with installed Java Runtime Environment.
+## Build
+
+Traccar is a Maven project. You need Java SDK version 6 or higher to build the project.
+
+### NetBeans (recommended)
+
+NetBeans comes pre-packaged with Maven plugin, so you don't need to install it separately.
+
+If your NetBeans doesn't have Maven plugin, then you need to download (`Tools > Plugins`) and configure (`Tools > Options > Miscellaneous > Maven`) it.
+
+To import project select `File > Open Project` and browse to the location of the project folder and click `Open Project`. To compile the project right click on the project and select `Build`.
+
+### Eclipse
+
+Eclipse is not recommended because of the number of reported problems with Eclipse Maven plugin.
+
+### IntelliJ IDEA
+
+Follow official instructions for <a href="https://www.jetbrains.com/idea/help/importing-project-from-maven-model.html">Importing Project from Maven Model</a>.
+
+### Command Line
+
+Make sure you have Maven and JDK installed. To generate binary files execute `mvn package` command in the terminal.
+
+### Create Installer
+
+Execute `setup/package.sh` shell script in the terminal.
+
## License
Apache License, Version 2.0
@@ -26,4 +54,3 @@ Traccar is open source server for various GPS tracking devices. Project is writt
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
diff --git a/README_MAVEN.txt b/README_MAVEN.txt
deleted file mode 100644
index a7ad20c9d..000000000
--- a/README_MAVEN.txt
+++ /dev/null
@@ -1,42 +0,0 @@
-==============================ECLIPSE===========================================
-
-If you use Eclipse for Jave EE, you can simply import the generated project
-into Eclipse. We've tested against Eclipse 3.6. Later versions will likely also
-work, earlier versions may not.
-
-Eclipse users will need to install the following plugin components:
-- m2eclipse Core
-- Maven Integration for WTP (in m2eclipse extras), Instructions for installing
- the maven plugins can be found here:
- http://m2eclipse.sonatype.org/installing-m2eclipse.html
-
-Ensure Eclipse is configured to use Java 1.6 as this sample uses AppEngine.
-
-In Eclipse, go to the File menu and choose:
-- File -> Import... -> Existing Maven Projects into Workspace
-- Select the directory containing this file.
-- Click Finish.
-
-You can now browse the project in Eclipse. To compile your project for
-deployment, just type 'mvn package'.
-
-==============================NETBEANS==========================================
-
-From the NetBeans IDE, install the Maven plugin. To do this, select Tools->
-Plugins, select Maven, click Install, and follow the prompts.
-
-Configure Maven in NetBeans IDE. To do this, select Tools->Options, select
-Miscellaneous from the top panel, then select the Maven tab.
-
-For the External Maven Home field, browse to your Maven installation.
-
-If the option is available, check Always use external Maven for building
-projects. Close the dialog.
-
-From the NetBeans IDE, select File->Open Project, and then browse to the
-location of the project you'd like to open.
-
-Check Open as Main Project, then click Open Project.
-
-Right-click the project and select Run.
-
diff --git a/README_SETUP.txt b/README_SETUP.txt
deleted file mode 100644
index c1a76a5fa..000000000
--- a/README_SETUP.txt
+++ /dev/null
@@ -1,20 +0,0 @@
-GENERAL SETUP:
-
-1. Download "wrapper-delta-pack-*.tar.gz" from http://wrapper.tanukisoftware.com/doc/english/download.jsp
-2. Download "isetup-*.exe" from http://www.jrsoftware.org/isdl.php
-3. Copy the files to "traccar/setup"
-4. Continue following the build instructions on http://www.traccar.org/docs/build.jsp
-
-NOTE: Linux Dependencies:
-- wine
-- innoextract
-- makeself
-
-Get innoextract on Ubuntu:
-- sudo add-apt-repository ppa:arx/release
-- sudo apt-get update
-- sudo apt-get install innoextract
-
-Get makeself on Ubuntu:
-- sudo apt-get update
-- sudo apt-get install makeself