From e7bcb3800256e5cf108826dfb020c8ae3fb54904 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: Thu, 18 Jul 2019 00:00:00 +0000 Subject: [PATCH] README: recommend using blob/README.adoc as well to see full README Document quick and dirty manual asciidoctor setup. --- README.adoc | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index 08a8730..01ccb50 100644 --- a/README.adoc +++ b/README.adoc @@ -15,7 +15,7 @@ TL;DR: <> -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 <>. +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 <>. toc::[] @@ -16026,7 +16026,16 @@ but note that this does not include script specific options. 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 @@ -16042,7 +16051,7 @@ Then the following times just to the faster: Source: link:build-doc[] -Then just open the HTML output at: +The HTML output is located at: .... xdg-open out/README.html