610efdc8a7bce2f87723c2a542271a15104bb528
[openwrt/staging/dangole.git] /
1 From 81eebfa296eb1454cde3bf1cbd919f8b9eb6cf64 Mon Sep 17 00:00:00 2001
2 From: Dave Stevenson <dave.stevenson@raspberrypi.com>
3 Date: Mon, 14 Nov 2022 17:14:15 +0000
4 Subject: [PATCH] README: Add README.md with CI kernel build status
5 tags
6
7 This is a copy of README with the tags added.
8
9 You can not delete the file README as then checkpatch complains
10 you aren't in a kernel tree.
11
12 Signed-off-by: Dave Stevenson <dave.stevenson@raspberrypi.com>
13 ---
14 README.md | 30 ++++++++++++++++++++++++++++++
15 1 file changed, 30 insertions(+)
16 create mode 100644 README.md
17
18 --- /dev/null
19 +++ b/README.md
20 @@ -0,0 +1,30 @@
21 +Linux kernel
22 +============
23 +
24 +There are several guides for kernel developers and users. These guides can
25 +be rendered in a number of formats, like HTML and PDF. Please read
26 +Documentation/admin-guide/README.rst first.
27 +
28 +In order to build the documentation, use ``make htmldocs`` or
29 +``make pdfdocs``. The formatted documentation can also be read online at:
30 +
31 + https://www.kernel.org/doc/html/latest/
32 +
33 +There are various text files in the Documentation/ subdirectory,
34 +several of them using the Restructured Text markup notation.
35 +
36 +Please read the Documentation/process/changes.rst file, as it contains the
37 +requirements for building and running the kernel, and information about
38 +the problems which may result by upgrading your kernel.
39 +
40 +Build status for rpi-5.15.y:
41 +[![Pi kernel build tests](https://github.com/raspberrypi/linux/actions/workflows/kernel-build.yml/badge.svg?branch=rpi-5.15.y)](https://github.com/raspberrypi/linux/actions/workflows/kernel-build.yml)
42 +[![dtoverlaycheck](https://github.com/raspberrypi/linux/actions/workflows/dtoverlaycheck.yml/badge.svg?branch=rpi-5.15.y)](https://github.com/raspberrypi/linux/actions/workflows/dtoverlaycheck.yml)
43 +
44 +Build status for rpi-6.0.y:
45 +[![Pi kernel build tests](https://github.com/raspberrypi/linux/actions/workflows/kernel-build.yml/badge.svg?branch=rpi-6.0.y)](https://github.com/raspberrypi/linux/actions/workflows/kernel-build.yml)
46 +[![dtoverlaycheck](https://github.com/raspberrypi/linux/actions/workflows/dtoverlaycheck.yml/badge.svg?branch=rpi-6.0.y)](https://github.com/raspberrypi/linux/actions/workflows/dtoverlaycheck.yml)
47 +
48 +Build status for rpi-6.1.y:
49 +[![Pi kernel build tests](https://github.com/raspberrypi/linux/actions/workflows/kernel-build.yml/badge.svg?branch=rpi-6.1.y)](https://github.com/raspberrypi/linux/actions/workflows/kernel-build.yml)
50 +[![dtoverlaycheck](https://github.com/raspberrypi/linux/actions/workflows/dtoverlaycheck.yml/badge.svg?branch=rpi-6.1.y)](https://github.com/raspberrypi/linux/actions/workflows/dtoverlaycheck.yml)