From 649d06d6758cefd080d04dc47fd6a5a26a620874 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciro=20Santilli=20=E5=85=AD=E5=9B=9B=E4=BA=8B=E4=BB=B6=20?= =?UTF-8?q?=E6=B3=95=E8=BD=AE=E5=8A=9F?= Date: Wed, 6 Feb 2019 00:00:04 +0000 Subject: [PATCH] design goals --- README.adoc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index f29e95e..efe6a23 100644 --- a/README.adoc +++ b/README.adoc @@ -21,6 +21,8 @@ Each child section describes a possible different setup for this repo. If you don't know which one to go for, start with <>. +Design goals of this project are documented at: <>. + === QEMU Buildroot setup ==== QEMU Buildroot setup getting started @@ -12096,7 +12098,7 @@ Tested on: `8.1.0_r60`. We tend to test this repo the most on the latest Ubuntu and on the latest link:https://askubuntu.com/questions/16366/whats-the-difference-between-a-long-term-support-release-and-a-normal-release[Ubuntu LTS]. -For other Linux distros, everything will likely also just work if you install the analogous required packages for your distro +For other Linux distros, everything will likely also just work if you install the analogous required packages for your distro. Find out the packages that we install with: @@ -13160,6 +13162,10 @@ The design goals are to provide setups that are: * can be fully built from source: to give visibility and allow modifications * can also use <> as much as possible: in case you are lazy or unable to build from source +We aim to make a documentation that contains a very high runnable example / theory bullshit ratio. + +Having at least one example per section is ideal, and it should be the very first thing in the section if possible. + ==== Setup trade-offs The trade-offs between the different <> are basically a balance between: