From 2494c94f6e8451653cdb9db5fbdf3a400daed22b Mon Sep 17 00:00:00 2001 From: Mikhail Klementev Date: Fri, 27 Dec 2019 08:38:47 +0000 Subject: [PATCH] Move build from source to documentation --- README.md | 38 -------------------------------------- docs/installation.rst | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 04c3793..90ca1db 100644 --- a/README.md +++ b/README.md @@ -31,43 +31,6 @@ out-of-tree is for automating some routine actions for creating development envi Read [documentation](https://out-of-tree.readthedocs.io) for further info. -## Build from source - -### Requirements - -[Qemu](https://www.qemu.org), [docker](https://docker.com) and [golang](https://golang.org) is required. - -Also do not forget to set GOPATH and PATH e.g.: - - $ echo 'export GOPATH=$HOME' >> ~/.bashrc - $ echo 'export PATH=$PATH:$HOME/bin' >> ~/.bashrc - $ source ~/.bashrc - -#### Gentoo - - # emerge app-emulation/qemu app-emulation/docker dev-lang/go - -#### macOS - - $ brew install go qemu - $ brew cask install docker - -#### Fedora - - $ sudo dnf install go qemu moby-engine - -Also check out [docker post-installation steps](https://docs.docker.com/install/linux/linux-postinstall/). - -### Build - - $ go get -u code.dumpstack.io/tools/out-of-tree - -Then you can check it on kernel module example: - - $ cd $GOPATH/src/code.dumpstack.io/tools/out-of-tree/examples/kernel-module - $ out-of-tree kernel autogen # generate kernels based on .out-of-tree.toml - $ out-of-tree pew - ## Examples Run by absolute path @@ -102,7 +65,6 @@ Generate all kernels $ out-of-tree kernel genall --distro Ubuntu --ver 16.04 - ## Troubleshooting If anything happens that you cannot solve -- just remove `$HOME/.out-of-tree`. diff --git a/docs/installation.rst b/docs/installation.rst index 6800b77..71d9190 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -36,6 +36,20 @@ There's a minimal configuration that you need to apply:: ]; } +Gentoo +------ + +Install dependencies:: + + $ sudo emerge app-emulation/qemu app-emulation/docker dev-lang/go + +Fedora +------ + +Install dependencies:: + + $ sudo dnf install go qemu moby-engine + Common ======