aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-10-18 10:46:38 -0200
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-10-24 08:12:35 -0200
commit6bef44b9b969a8bcf49f28a3079400ab1dac5769 (patch)
tree861bcad359ced52ff574f31bdd26eaa31dd49f15 /README
parent08a9a8d44c1c0e1b6d765a627b6f895dc6202e9b (diff)
download96b-common-6bef44b9b969a8bcf49f28a3079400ab1dac5769.tar.gz
README: add a new README file, pointing to the Documentation/
As we moved the real README file to Documentation/admin-guide/README.rst, let's add a replacement, pointing to it, and giving the main directions about documentation. In the future, perhaps it would be worth to move the contents of Documentation/00-Index into this README. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
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 000000000000..b2ba4aaa3a71
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+Linux kernel
+============
+
+This file was moved to Documentation/admin-guide/README.rst
+
+Please notice that there are several guides for kernel developers and users.
+These guides can be rendered in a number of formats, like HTML and PDF.
+
+In order to build the documentation, use ``make htmldocs`` or
+``make pdfdocs``.
+
+There are various text files in the Documentation/ subdirectory,
+several of them using the Restructured Text markup notation.
+See Documentation/00-INDEX for a list of what is contained in each file.
+
+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.