summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRoland Hieber <rhi@pengutronix.de>2021-03-26 21:07:58 +0100
committerRoland Hieber <rhi@pengutronix.de>2021-03-26 21:07:58 +0100
commitb30a3162f2f9374475bcc955f152e69fa1c8054c (patch)
tree71482f93453338287d7be2023687693d6e98c052
parent50f7f71f81da2b2544098c7d4a83f7f894503ebb (diff)
downloaddt-utils-master.tar.gz
dt-utils-master.tar.xz
update READMEHEADmaster
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
-rw-r--r--README48
1 files changed, 42 insertions, 6 deletions
diff --git a/README b/README
index 7b981d3..20c9e34 100644
--- a/README
+++ b/README
@@ -1,15 +1,51 @@
-Questions, feedback, patches please email:
- oss-tools@pengutronix.de
+Utilities to work with device trees in Linux userspace
-For patches, please prefix your subject with "[PATCH dt-utils]" (for example,
-see the git-config manpage for the option format.subjectPrefix).
+The following tools are available:
+
+* barebox-state: access barebox' state storage
+* fdtdump: dump a device tree binary to stdout
+* dtblint: lint a compiled device tree
+
+For questions, feedback, patches, please send a mail to
+
+ <oss-tools@pengutronix.de>
+
+Note: you must be subscribed to post to this mailing list. You can do so by
+sending an empty mail to <oss-tools-subscribe@pengutronix.de>.
+
+Contributing
+------------
+
+The Git repository for this software can be found at
+
+ <https://git.pengutronix.de/cgit/tools/dt-utils>
+
+Any patches should be sent to the mailing list above. Please prefix your
+subject with "[PATCH dt-utils]" (when sending patches with Git, see the
+git-config manpage for the option format.subjectPrefix).
This project uses the Developer's Certificate of Origin, as stated in the file
-DCO in this repository, with the same process as used for the Linux kernel:
-<https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin>
+DCO bundled with this software, using the same process as for the Linux kernel:
+
+ <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin>
+
By adding a Signed-off-by line (e.g. using `git commit -s`) saying
Signed-off-by: Random J Developer <random@developer.example.org>
(using your real name and e-mail address), you state that your contributions
are in line with the DCO.
+
+License
+-------
+
+Copyright (C) 2021 Pengutronix and contributors
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License, version 2 as published by the Free
+Software Foundation.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License (the file COPYING
+bundled with this software) for more details.