summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorkx <kx@radix.pro>2023-10-28 12:00:06 +0300
committerkx <kx@radix.pro>2023-10-28 12:00:06 +0300
commit8f3ce5b3998ec82c96385f8ce3d5fd6d24c8b859 (patch)
tree5bda49164664ad1429852668300d19bf559c830a /README
downloadlinux-orangepi-5.10.y-8f3ce5b3998ec82c96385f8ce3d5fd6d24c8b859.tar.xz
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 000000000..669ac7c32
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+Linux kernel
+============
+
+There are several guides for kernel developers and users. These guides can
+be rendered in a number of formats, like HTML and PDF. Please read
+Documentation/admin-guide/README.rst first.
+
+In order to build the documentation, use ``make htmldocs`` or
+``make pdfdocs``. The formatted documentation can also be read online at:
+
+ https://www.kernel.org/doc/html/latest/
+
+There are various text files in the Documentation/ subdirectory,
+several of them using the Restructured Text markup notation.
+
+Please read the Documentation/process/changes.rst file, as it contains the
+requirements for building and running the kernel, and information about
+the problems which may result by upgrading your kernel.