summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-03-23 13:26:19 +0200
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-04-03 04:03:37 +0300
commitef2213fdb673bbc9b7ae9e62db83d6edaf824d5e (patch)
tree323f5ef9468ff8f54fefa1ebdbdd4e0688799dd7
parent8634c38675a120b3650f9226871e57166aa21b26 (diff)
Documentation: Add getting started section
Pull the "getting started" of README.rst in the documentation tree, as done on libcamera.org, to ensure documentation build coverage of the whole README.rst. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
-rw-r--r--Documentation/getting-started.rst4
-rw-r--r--Documentation/index.rst1
2 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/getting-started.rst b/Documentation/getting-started.rst
new file mode 100644
index 00000000..4cc34a17
--- /dev/null
+++ b/Documentation/getting-started.rst
@@ -0,0 +1,4 @@
+.. Getting started information is defined in the project README file.
+.. include:: ../README.rst
+ :start-after: .. section-begin-getting-started
+ :end-before: .. section-end-getting-started
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 285ca7c3..7e3fe2f6 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -12,6 +12,7 @@
Home <self>
Docs <docs>
Contribute <contributing>
+ Getting Started <getting-started>
Developer Guide <guides/introduction>
Application Writer's Guide <guides/application-developer>