diff --git a/docs/0install/setup.md b/docs/0install/setup.md new file mode 100644 index 00000000..2d961ef8 --- /dev/null +++ b/docs/0install/setup.md @@ -0,0 +1,17 @@ +## Prerequisites + +1. Install [0install](http://0install.net/injector.html) on your machine. + +#### OpenJDK (For linux OS) + +See [OpenJDK guide](http://openjdk.java.net/install/) for more information. + +#### Oracle Java JRE (Windows and Mac OS) + +See [Oracle Java SE](http://www.oracle.com/technetwork/java/javase/downloads/index.html) for more information. + +#### Homebrew JRE (Mac OS) + +- Install homebrew +- Install cask `brew install caskroom/cask/brew-cask` +- `brew cask install java` \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index 090d6f93..e55ee357 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -11,9 +11,50 @@ sudo yum install zanata-client *Note:* If you are not running the latest version of Fedora, the latest version of the client may not be available, so you might want to try the Ivy version (below). -## Installation with Ivy +## Installation with Ivy (Recommended) + +The Ivy distribution of the client is a small script that will download the client the first time it is run. This distribution requires Apache Ivy to run. + +1. See [Setup Ivy](/ivy/setup) for Apache Ivy installation. +2. Save [this script](https://raw.github.com/zanata/zanata-client-ivy/master/zanata-cli) somewhere on your path, and make sure it is executable. For example, assuming you have `~/bin in $PATH`, + +``` +cd ~/bin +wget https://raw.github.com/zanata/zanata-client-ivy/master/zanata-cli +chmod 755 zanata-cli +``` + +*Note:* It's a good idea to check for a new version of zanata-cli once in a while (especially when a new version of Zanata server is released). + + +## Installation with 0install + +The 0install distribution of the client is to allow zanata-cli to be available on multiple platform. This distribution requires [0install](http://0install.net/) to run. + +1. See [Setup 0install](/0install/setup) for 0install installation. +2. If you are new to Zanata-CLI, run command below to install zanata-cli. + + ``` + 0install -c add zanata-cli http://zanata.org/files/0install/zanata-cli.xml + ``` + + Now you can run `zanata-cli --help` for more options. + + + If you already have a copy of zanata-cli in your machine and wish to keep 0install zanata-cli as a separate command, you can still run 0install with: + + ``` + 0launch http://zanata.org/files/0install/zanata-cli.xml {command} + ``` + +#### Update 0install Zanata-CLI + +To update Zanata CLI, run + +``` +0install update http://zanata.org/files/0install/zanata-cli.xml +``` -See [Ivy installation](/ivy/installation) for more information. ## Manual Installation diff --git a/docs/ivy/installation.md b/docs/ivy/installation.md deleted file mode 100644 index 2f12850a..00000000 --- a/docs/ivy/installation.md +++ /dev/null @@ -1,12 +0,0 @@ -The Ivy distribution of the client is a small script that will download the client the first time it is run. This distribution requires Apache Ivy to run. - -1. See [Setup Ivy](/ivy/setup) for Apache Ivy installation. -2. Save [this script](https://raw.github.com/zanata/zanata-client-ivy/master/zanata-cli) somewhere on your path, and make sure it is executable. For example, assuming you have `~/bin in $PATH`, - -``` -cd ~/bin -wget https://raw.github.com/zanata/zanata-client-ivy/master/zanata-cli -chmod 755 zanata-cli -``` - -*Note:* It's a good idea to check for a new version of zanata-cli once in a while (especially when a new version of Zanata server is released). diff --git a/mkdocs.yml b/mkdocs.yml index a1ed7a56..f20bc070 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,9 +11,8 @@ pages: - Installation: 'installation.md' - Configuration: 'configuration.md' - Command Hook: 'command-hook.md' -- Ivy: - - Installation: 'ivy/installation.md' - - Setup: 'ivy/setup.md' +- Ivy setup: 'ivy/setup.md' +- 0install setup: '0install/setup.md' - Maven Plugin: - Installation: 'maven-plugin/installation.md' - Configuration: 'maven-plugin/configuration.md'