summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRunar Borge <runar@borge.nu>2018-12-28 23:21:44 +0100
committerRunar Borge <runar@borge.nu>2018-12-28 23:21:44 +0100
commit396501bbbfc1a49337b812acd66b7a89fc40a0b8 (patch)
tree1f114b8fcea0bf3d613b8a59d02ea0a1983310cf /README.md
parent39948ad83881fe7ac9fb967bc1ae83b3ddecbe5d (diff)
downloadvyos-build-396501bbbfc1a49337b812acd66b7a89fc40a0b8.tar.gz
vyos-build-396501bbbfc1a49337b812acd66b7a89fc40a0b8.zip
Rename build script to build-submodules and removed docker from the build process.
The script was originally named `build-docker-subpackages` and executed docker for every package built. This has now changed so that the user could choose to do a docker or native build. The readme is aldo updated to reflect this change.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md
index cda94ded..c6460aff 100644
--- a/README.md
+++ b/README.md
@@ -175,14 +175,22 @@ for dir in packages/*; do
done
```
### Building packages
-Most packages can be built by using the vyos-builder docker container with the same parameters, the vyos-builder container should include all dependencies for compiling supported packages.
-The script `./scripts/build-docker-subpackages` is created to automate the process of building packages, just execute it in the root of vyos-build to start compilation on all supported packages that are checked out.
+The script `./scripts/build-submodules` is created to automate the process of building packages, execute it in the root of `vyos-build` to start compilation on all supported packages that are checked out.
+
+The easiest way to compile is with the `vyos-builder` docker container, it includes all dependencies for compiling supported packages.
+
+```bash
+$ docker run --rm -it -v $(pwd):/vyos -w /vyos \
+ --sysctl net.ipv6.conf.lo.disable_ipv6=0 \
+ vyos-builder \
+ ./scripts/build-submodules
+```
NOTE: Prior to executing this script you need to create/build the `vyos-builder` container and checkout all packages you want to compile.
### Building one package
-the script above runs a docker container for every build it does. this is also possible to do by hand using:
-Ecevuted from the root directory of vyos-build
+the script above runs all package build inside a docker container, this is also possible to do by hand using:
+Executed from the root directory of vyos-build
```bash
$ docker run --rm -it -v $(pwd):/vyos -w /vyos/packages/PACKAGENAME \
--sysctl net.ipv6.conf.lo.disable_ipv6=0 \