summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJernej Jakob <jernej.jakob@gmail.com>2019-12-21 16:24:28 +0100
committerJernej Jakob <jernej.jakob@gmail.com>2019-12-21 16:24:28 +0100
commit049f2014aa5b10cf30f94c9555232bf90bb5bc3d (patch)
tree5c1b6a89fe39d38305468943319595547642e436 /README.md
parent972daf259af7789ca5b5facfa1cc7dbd55f9b5b7 (diff)
downloadvyos-build-049f2014aa5b10cf30f94c9555232bf90bb5bc3d.tar.gz
vyos-build-049f2014aa5b10cf30f94c9555232bf90bb5bc3d.zip
README: point users to docs.vyos.io, remove manual building section
Point users to docs.vyos.io, this readme is duplicated there. Since building with debootstrap isn't supported since a long time ago, remove the section.
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 4 insertions, 38 deletions
diff --git a/README.md b/README.md
index 85778c49..55425920 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,9 @@
VyOS toplevel build
===================
+**For the most up-to-date documentation, please read
+[the online build docs at docs.vyos.io](https://docs.vyos.io/en/latest/contributing/build-vyos.html)**
+
# What is VyOS
VyOS is an open source operating system for network devices (routers, firewalls
@@ -38,44 +41,7 @@ There are several directories with their own purpose:
* `tools/` Scripts that are used for maintainer's tasks automation and other
purposes, but not during ISO build process
-# Building installation images
-
-## Prerequisites
-
-To build a VyOS 1.2.0 image, you need Debian 8 "Jessie" environment (with
-jessie-backports repository).
-
-If you are working on a Debian Jessie machine, no special preparation is needed,
-you only need to enable jessie-backports and install build dependencies.
-
-If you are interested which individual packages are required please check our
-[Dockerfile](docker/Dockerfile) which holds the most complete documentation
-of required packages. Listing individual packages here tend to be always
-outdated. We try to list required packages in groups through their inheritance
-in the [Dockerfile](docker/Dockerfile).
-
-### Debootstrap
-
-If you do not have a Debian Jessie machine, you may create a chroot environment
-with the [debootstrap](https://wiki.debian.org/Debootstrap) tool.
-
-For example, on another version of Debian or another Debian-based distro, these
-commands will work:
-
-```bash
-$ sudo apt-get install debootstrap
-$ sudo debootstrap jessie vyos-chroot
-$ sudo chroot vyos-chroot
-
-$ echo "deb http://archive.debian.org/debian/ jessie-backports main" >> /etc/apt/sources.list
-$ apt-get update -o Acquire::Check-Valid-Until=false
-```
-
-**NOTE:** We recommend to use the Docker build method
-
-### Docker
-
-**NOTE:** Currently the image can only be build with docker on Linux system
+# Building images using Docker
Using our [Dockerfile](docker/Dockerfile) you create your own Docker container
that is used to build a VyOS ISO image or other required VyOS packages. The