diff --git a/README.md b/README.md index d72680d..ef0a854 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,22 @@ Read [Qemu API](qemu/README.md). cd $GOPATH/src/github.com/jollheef/out-of-tree/tools/kernel-factory ./bootstrap.sh # more than 6-8 hours for all kernels + +### "I just want to see how it works" + +If you already have Go, Qemu, Vagrant and Docker installed, there's cross-platform installation checklist: + + $ go get github.com/jollheef/out-of-tree + $ cd $GOPATH/src/github.com/jollheef/out-of-tree + $ cd tools/qemu-debian-img/ + $ vagrant up && vagrant destroy -f + $ cd ../kernel-factory + $ rm -rf {Debian,CentOS,Ubuntu/{14.04,18.04}} # speed up :) + $ ./bootstrap.sh + $ # wait several hours... + $ cd ../../examples/kernel-exploit + $ # test kernel exploit + $ out-of-tree + $ cd ../kernel-module + $ # test kernel module + $ out-of-tree