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: recommend using blob/README.adoc as well to see full README

Browse Source 
Document quick and dirty manual asciidoctor setup.
This commit is contained in:
Ciro Santilli 六四事件 法轮功
2019-07-18 00:00:00 +00:00
parent a61dea2743
commit e7bcb38002
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.adoc
View File

@@ -15,7 +15,7 @@
TL;DR: <<qemu-buildroot-setup-getting-started>> TL;DR: <<qemu-buildroot-setup-getting-started>>
The source code for this page is located at: https://github.com/cirosantilli/linux-kernel-module-cheat[]. Due to https://github.com/isaacs/github/issues/1610[a GitHub limitation], this README is too long and not fully rendered on github.com. Either use: https://cirosantilli.com/linux-kernel-module-cheat or <<build-the-documentation,build the docs yourself>>. The source code for this page is located at: https://github.com/cirosantilli/linux-kernel-module-cheat[]. Due to https://github.com/isaacs/github/issues/1610[a GitHub limitation], this README is too long and not fully rendered on github.com. Either use: link:README.adoc[], https://cirosantilli.com/linux-kernel-module-cheat or <<build-the-documentation,build the docs yourself>>.
toc::[] toc::[]
@@ -16026,7 +16026,16 @@ but note that this does not include script specific options.
You don't need to depend on GitHub. You don't need to depend on GitHub.
To build the first time use: For a quick and dirty build, install https://asciidoctor.org/[Asciidoctor] however you like and build:
....
asciidotor README.adoc
xdg-open README.html
....
For development, you will want to do a more controlled build with extra error checking as follows.
For the initial build do:
.... ....
./build --download-dependencies docs ./build --download-dependencies docs
@@ -16042,7 +16051,7 @@ Then the following times just to the faster:
Source: link:build-doc[] Source: link:build-doc[]
Then just open the HTML output at: The HTML output is located at:
.... ....
xdg-open out/README.html xdg-open out/README.html