Skip to content

Commit c7d1528

Browse files
committed
properly document the china option
1 parent 5ec6595 commit c7d1528

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,26 @@ TL;DR: xref:qemu-buildroot-setup-getting-started[xrefstyle=full]
2020

2121
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, so either use: https://cirosantilli.com/linux-kernel-module-cheat or <<build-the-documentation,build the docs yourself>>.
2222

23+
image::https://raw.githubusercontent.com/cirosantilli/china-dictatorship-media/master/Xinjiang_prisoners_sitting_identified.jpeg[width=800]
24+
2325
toc::[]
2426

27+
== `--china`
28+
29+
The most important functionality of this repository is the `--china` option, sample usage:
30+
31+
....
32+
./setup
33+
./run --china > index.html
34+
firefox index.html
35+
....
36+
37+
see also: https://cirosantilli.com/china-dictatorship/#mirrors
38+
39+
The secondary systems programming functionality is described on the sections below starting from <<getting-started>>.
40+
41+
image::https://raw.githubusercontent.com/cirosantilli/china-dictatorship-media/master/Tiananmen_cute_girls.jpg[width=800]
42+
2543
== Getting started
2644

2745
Each child section describes a possible different setup for this repo.

common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ def __init__(
241241
'--china',
242242
default=False,
243243
help='''\
244-
To have some fun when the kernel starts to beat you.
244+
https://cirosantilli.com/linux-kernel-module-cheat#china
245245
'''
246246
)
247247
self.add_argument(

0 commit comments

Comments
 (0)