Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix documentation, instructions for release download #233

Merged
merged 2 commits into from
Aug 7, 2018
Merged

fix documentation, instructions for release download #233

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51309bc
fix documentation, instructions for release download
VivianLopes Aug 7, 2018
c9592be
fixed documentation
VivianLopes Aug 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/user-guide/basic-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Starting Styx

## System Requirements

Running Styx requires Java 1.8. It can be run with 1.8.0_45 or later versions. Earlier maintenance
releases or Java 1.9 may work, but are not guaranteed to.

## Downloading Styx from release

In order to download Styx from release, go to [Styx releases](https://github.com/HotelsDotCom/styx/releases) and download the zip file for the version you want, making sure you choose the file corresponding to whichever operating system you are using.
Alternatively, you can build styx from source code.

## Building Styx from source code

In order to build styx from source code, Java 8 (1.8.0_45 or later) is required.
Expand All @@ -14,12 +24,6 @@
git clone https://github.com/HotelsDotCom/styx.git
cd styx && mvn package
```

## System Requirements

Running Styx requires Java 1.8. It can be run with 1.8.0_45 or later versions. Earlier maintenance
releases or Java 1.9 may work, but are not guaranteed to.


## Step 1: Installing Styx:

Expand Down