From 12b106f129591809010c99521ff8b65c13d826d8 Mon Sep 17 00:00:00 2001 From: Charlie Drage Date: Mon, 10 Apr 2017 09:21:47 -0400 Subject: [PATCH] Add setup.md Adds setup.md to the docs folder in order to sync with changes to http://kompose.io site (whenever we update setup.md here, it'll update on the gh-pages branch). --- README.md | 44 +++++++++------------------------------- docs/setup.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 34 deletions(-) create mode 100644 docs/setup.md diff --git a/README.md b/README.md index b5af1ff8..724c5b3d 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,16 @@ Other examples are provided in the _examples_ [directory](./examples). We have multiple ways to install Kompose. Our prefered method is downloading the binary from the latest GitHub release. -#### GitHub release +Our entire list of installation methods are located in our [setup.md](/docs/setup.md) document. + +Installation methods: + - [Binary (Prefered method)](README.md) + - [Go](/docs/setup.md#go) + - [CentOS](/docs/setup.md#centos) + - [Fedora](/docs/setup.mdfedora) + - [macOS (Homebrew)](/docs/setup.md#macos) + +#### Binary installation Kompose is released via GitHub on a three-week cycle, you can see all current releases on the [GitHub release page](https://github.com/kubernetes-incubator/kompose/releases). @@ -55,39 +64,6 @@ sudo mv ./kompose /usr/local/bin/kompose Alternatively, you can download the [tarball](https://github.com/kubernetes-incubator/kompose/releases). -#### Go - -Installing using `go get` pulls from the master branch with the latest development changes. - -```sh -go get -u github.com/kubernetes-incubator/kompose -``` - -#### CentOS - -Kompose is in [EPEL](https://fedoraproject.org/wiki/EPEL) CentOS repository. -If you don't have [EPEL](https://fedoraproject.org/wiki/EPEL) repository already installed and enabled you can do it by running `sudo yum install epel-release` - -If you have [EPEL](https://fedoraproject.org/wiki/EPEL) enabled in your system, you can install Kompose like any other package. -```bash -sudo yum -y install kompose -``` - -#### Fedora -Kompose is in Fedora 24 and 25 repositories. You can install it just like any other package. - -```bash -sudo dnf -y install kompose -``` - -#### Mac OS X -On Mac OS X you can install latest release via [Homebrew](https://brew.sh): - -```bash -brew install kompose - -``` - ## Shell autocompletion We support both `bash` and `zsh` for autocompletion. diff --git a/docs/setup.md b/docs/setup.md new file mode 100644 index 00000000..76e3fc91 --- /dev/null +++ b/docs/setup.md @@ -0,0 +1,56 @@ +## Installation + +We have multiple ways to install Kompose. Our prefered method is downloading the binary from the latest GitHub release. + +#### GitHub release + +Kompose is released via GitHub on a three-week cycle, you can see all current releases on the [GitHub release page](https://github.com/kubernetes-incubator/kompose/releases). + +```sh +# Linux +curl -L https://github.com/kubernetes-incubator/kompose/releases/download/v0.5.0/kompose-linux-amd64 -o kompose + +# macOS +curl -L https://github.com/kubernetes-incubator/kompose/releases/download/v0.5.0/kompose-darwin-amd64 -o kompose + +# Windows +curl -L https://github.com/kubernetes-incubator/kompose/releases/download/v0.5.0/kompose-windows-amd64.exe -o kompose.exe + +chmod +x kompose +sudo mv ./kompose /usr/local/bin/kompose +``` + +Alternatively, you can download the [tarball](https://github.com/kubernetes-incubator/kompose/releases). + +#### Go + +Installing using `go get` pulls from the master branch with the latest development changes. + +```sh +go get -u github.com/kubernetes-incubator/kompose +``` + +#### CentOS + +Kompose is in [EPEL](https://fedoraproject.org/wiki/EPEL) CentOS repository. +If you don't have [EPEL](https://fedoraproject.org/wiki/EPEL) repository already installed and enabled you can do it by running `sudo yum install epel-release` + +If you have [EPEL](https://fedoraproject.org/wiki/EPEL) enabled in your system, you can install Kompose like any other package. +```bash +sudo yum -y install kompose +``` + +#### Fedora +Kompose is in Fedora 24 and 25 repositories. You can install it just like any other package. + +```bash +sudo dnf -y install kompose +``` + +#### macOS +On macOS you can install latest release via [Homebrew](https://brew.sh): + +```bash +brew install kompose + +```