3rd-party/linux-kernel-module-cheat
1
0
Fork 0
mirror of https://github.com/cirosantilli/linux-kernel-module-cheat.git synced 2026-01-23 02:05:57 +01:00
Code Issues Releases Wiki Activity

readme: improve getting started organization

Browse Source
This commit is contained in:
Ciro Santilli
2018-05-29 10:59:34 +01:00
parent 32ccda88c8
commit c7ab01967d
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.adoc
View File

@@ -15,11 +15,13 @@ toc::[]
== Getting started
=== Getting started natively
=== Setup types
This is the best one if you are on one of the supported Ubuntu: 16.04 or 18.04.
==== Getting started natively
It will likely work on other Linux distros if you install the required packages, but this is not currently well tested, but patches are welcome. You can also try <<docker>> if you are on other distros.
This is the best setup if you are on one of the supported systems: Ubuntu 16.04 or Ubuntu 18.04.
Everything will likely also work on other Linux distros if you install the analogous required packages for your distro from link:configure[], but this is not currently well tested. Compatibility patches are welcome. You can also try <<docker>> if you are on other distros.
Reserve 12Gb of disk and run:
@@ -117,12 +119,10 @@ We will try to support the following Ubuntu versions at least:
* otherwise, support both latest LTS and the latest non-LTS
[[docker]]
=== Getting started with Docker
==== Getting started with Docker
This is a good option if you are on a Linux host, but the <<getting-started-natively,native build>> failed due to your weird host distribution.
Note however that most things in this repository are highly Linux-portable, should just work once you have found the corresponding `apt-get` package manager commands in the link:configure[] for your distro. In theory :-)
Before anything, you must get ride of any host build files on `out/` if you have any. A simple way to do this it to:
....
@@ -224,7 +224,7 @@ After this, to start using Docker again will you need another:
....
[[prebuilt]]
=== Getting started with prebuilts
==== Getting started with prebuilts
We don't currently provide a full prebuilt because it would be too big to host freely.
@@ -261,7 +261,7 @@ Maybe we could work around this by just downloading the kernel source somehow, a
* <<gem5>> is not currently supported, although it should not be too hard to do. One annoyance is that there is no Debian package for it, so you have to compile your own, so you might as well just build the image itself.
[[host]]
=== Getting started on host
==== Getting started on host
This method runs the kernel modules directly on your host computer without a VM, and saves you the compilation time and disk usage of the virtual machine method.