diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-10-18 08:46:38 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-10-24 06:12:35 -0400 |
commit | 6bef44b9b969a8bcf49f28a3079400ab1dac5769 (patch) | |
tree | 861bcad359ced52ff574f31bdd26eaa31dd49f15 | |
parent | 08a9a8d44c1c0e1b6d765a627b6f895dc6202e9b (diff) |
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>
-rw-r--r-- | README | 18 |
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 @@ | |||
1 | Linux kernel | ||
2 | ============ | ||
3 | |||
4 | This file was moved to Documentation/admin-guide/README.rst | ||
5 | |||
6 | Please notice that there are several guides for kernel developers and users. | ||
7 | These guides can be rendered in a number of formats, like HTML and PDF. | ||
8 | |||
9 | In order to build the documentation, use ``make htmldocs`` or | ||
10 | ``make pdfdocs``. | ||
11 | |||
12 | There are various text files in the Documentation/ subdirectory, | ||
13 | several of them using the Restructured Text markup notation. | ||
14 | See Documentation/00-INDEX for a list of what is contained in each file. | ||
15 | |||
16 | Please read the Documentation/process/changes.rst file, as it contains the | ||
17 | requirements for building and running the kernel, and information about | ||
18 | the problems which may result by upgrading your kernel. | ||