diff mbox series

add README

Message ID 20220112135453.5927-1-quentin.schulz@theobroma-systems.com
State Superseded
Headers show
Series add README | expand

Commit Message

Quentin Schulz Jan. 12, 2022, 1:54 p.m. UTC 
From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

This adds a README to the project so that the contribution process is
explicit as well as the licenses that apply to the source code.

Cc: Quentin Schulz <foss+kernel@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 README | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README
diff mbox series

Patch

diff --git a/README b/README
new file mode 100644
index 0000000..47f436b
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@ 
+MMC tools (mmc-utils)
+=====================
+
+mmc-utils is a tool for configuring MMC storage devices from userspace.
+
+Contribution guidelines
+-----------------------
+
+The project works using a mailing list patch submission process, similar to the
+process used for the Linux kernel itself.
+
+One can document themselves by reading how to submit a patch in the official
+Linux kernel documentation:
+https://www.kernel.org/doc/html/latest/process/submitting-patches.html
+
+Not all sections apply but it should be a good way to get started.
+
+A patch should be sent as a mail (not as an attachement, see documentation
+abiove) to the linux-mmc@vger.kernel.org mailing list with maintainers as
+Cc recipients.
+
+Maintainers
+-----------
+
+Ulf Hansson <ulf.hansson@linaro.org>
+
+License
+-------
+
+This project is licensed under:
+ - BSD-3-Clause for lsmmc,
+ - GPL-2.0-only for everything else,