[PATCH] add README

[PATCH] add README

[Stephen Hemminger]

This project is missing a proper README which is used in
other projects and some git visualization services.
Only a starting point, please feel free to edit.
To keep the file short and current, I avoided putting any specific
information about features and versions.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 README | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..29ba0e0
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+DPDK is a set of libraries and drivers for fast packet processing.
+It supports many processor architectures and both FreeBSD and Linux.
+
+The DPDK uses the Open Source BSD license for the core libraries and
+drivers. The kernel components are GPLv2 licensed.
+
+Please check the doc directory for release notes,
+API documentation, and sample application information.
+
+For questions and usage discussions, subscribe to: users@dpdk.org
+Report bugs and issues to the development mailing list: dev@dpdk.org
-- 
2.1.4

Re: [PATCH] add README

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Stephen Hemminger
> Sent: Wednesday, December 2, 2015 4:20 AM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] add README
> 
> This project is missing a proper README which is used in other projects
> and some git visualization services.
> Only a starting point, please feel free to edit.
> To keep the file short and current, I avoided putting any specific
> information about features and versions.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [PATCH] add README

[Thomas Monjalon]

> > This project is missing a proper README which is used in other projects
> > and some git visualization services.
> > Only a starting point, please feel free to edit.
> > To keep the file short and current, I avoided putting any specific
> > information about features and versions.
> > 
> > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks

[PATCH] add README

[quentin.schulz]

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 --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,
-- 
2.34.1

Re: [PATCH] add README

[Ulf Hansson]

+ Avri

On Wed, 12 Jan 2022 at 14:56, <quentin.schulz@theobroma-systems.com> wrote:
>
> 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>

Thanks for doing this!

> ---
>  README | 32 ++++++++++++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
>  create mode 100644 README
>
> 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

/s/abiove/above

> +Cc recipients.
> +
> +Maintainers
> +-----------
> +
> +Ulf Hansson <ulf.hansson@linaro.org>

Please add Avri here too:
Avri Altman <avri.altman@wdc.com>

Avri, can you please ack this so we know that you are okay with this?

> +
> +License
> +-------
> +
> +This project is licensed under:
> + - BSD-3-Clause for lsmmc,
> + - GPL-2.0-only for everything else,
> --
> 2.34.1
>

Kind regards
Uffe