Skip to content

Commit

Permalink
Fix markdown syntax errors
Browse files Browse the repository at this point in the history
  • Loading branch information
jrossi227 authored Mar 20, 2017
1 parent 2acdc82 commit 5a57191
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Website
----------------
The ApacheGUI website is located here [http://apachegui.net](http://apachegui.net). Questions and comments can be posted on the [forum](http://forum.apachegui.net) or sent directly to apachegui.net@gmail.com.
The ApacheGUI website is located here [http://apachegui.net](http://apachegui.net). Questions and comments can be sent directly to apachegui.net@gmail.com.

Packages
----------------
Expand All @@ -11,10 +11,10 @@ Development Environment
---------------
ApacheGUI is a Maven enabled web project. The project is portable and can be imported to any Java IDE as a Maven project.

####Linux / Mac OSX runtime environment
#### Linux / Mac OSX runtime environment
The IX based runtime environment that is used for development is located under *environments/IX/ApacheGUI*.

####Windows runtime environment
#### Windows runtime environment
The Windows based runtime environment that is used for development is located under *environments/Windows64/ApacheGUI* or *environments/Windows32/ApacheGUI*.

Project Dependancies
Expand All @@ -28,30 +28,30 @@ Building ApacheGUI
----------------
Although Windows is fully supported, it is recommended to use a Linux or Mac OSX distribution when developing ApacheGUI. This is because Apache and Tomcat run more efficiently on IX based distributions.

####Build Dependancies
#### Build Dependancies

- Node js v0.10.25+
- Maven 3+
- Java 1.6+

####Linux / Mac OSX build steps
#### Linux / Mac OSX build steps
1. Navigate to the root directory in the source project (Where pom.xml is located).
2. Open pom.xml and set the *environment* property to IX. The *apachegui.home* property uses the environment property to determine the location of ApacheGUI.
3. Run the Maven builds below.

######Maven options
###### Maven options
- ```mvn clean package -P prod``` minifies required javascript and builds a new war under the *target* directory.
- ```mvn clean package -P dev``` copies required javascript without minification and builds a new war under the *target* directory. This task is meant to speed up war builds for development.
- ```mvn clean install -P prod``` minifies required javascript and builds a new war under the *target* directory. The war is then moved from the *target* directory to *[apachegui.home]/tomcat/webapps*. This will re-deploy the application.
- ```mvn clean install -P dev``` copies required javascript without minification and builds a new war under the *target* directory. The war is then moved from the *target* directory to *[apachegui.home]/tomcat/webapps*. This will re-deploy the application. This task is meant to speed up war builds for development.
- ```mvn antrun:run -P package``` stops ApacheGUI and builds a new .tar.gz archive. The .tar.gz archive is put into the *package.dir* directory that is specified in the pom.xml properties.

####Windows build steps
#### Windows build steps
1. Navigate to the root directory in the source project (Where pom.xml is located).
2. Open pom.xml and set the *environment* property in pom.xml to Windows64 or Windows32 depending on your WIndows architecture. The *apachegui.home* property uses the environment property to determine the location of ApacheGUI.
3. Run the Maven builds below.

######Maven options
###### Maven options
- ```mvn clean package -P prod``` minifies required javascript and builds a new war under the *target* directory.
- ```mvn clean package -P dev``` copies required javascript without minification and builds a new war under the *target* directory. This task is meant to speed up war builds for development.
- ```mvn clean install -P prod``` minifies required javascript and builds a new war under the *target* directory. The task then stops ApacheGUI, moves the war from the *target* directory to *[apachegui.home]/tomcat/webapps* and starts ApacheGUI. This will re-deploy the application.
Expand All @@ -62,22 +62,22 @@ Running ApacheGUI
-----------------
You must first build ApacheGUI in order to successfuly launch the application.

####Linux / Mac OSX
#### Linux / Mac OSX
1. Navigate to *environments/IX/ApacheGUI/bin*
2. Launch run.sh

####Windows
#### Windows
1. Navigate to *environments/Windows64/ApacheGUI/bin* or *environments/Windows32/ApacheGUI/bin*
2. Launch run.bat

Stopping ApacheGUI
-----------------
You must first build ApacheGUI in order to successfuly stop the application.

####Linux / Mac OSX
#### Linux / Mac OSX
1. Navigate to *environments/IX/ApacheGUI/bin*
2. Launch stop.sh

####Windows
#### Windows
1. Navigate to *environments/Windows64/ApacheGUI/bin* or *environments/Windows32/ApacheGUI/bin*
2. Launch stop.bat

0 comments on commit 5a57191

Please sign in to comment.