mmc-utils/README
Avri Altman c8cef0598b mmc-utils: Add Read-the-Docs configuration
Prior of building the documentation page, read-the-docs expects a github
project to be imported into it, so I had to mirror the mmc-utils repo
into https://github.com/avri-altman-wdc/mmc-utils.  It also expects some
mandatory settings in a configuration file - .readthedocs.yaml, add
those as well.  Finally, the public documentation is in
https://mmc-utils.readthedocs.io/en/latest/

Signed-off-by: Avri Altman <avri.altman@wdc.com>
Link: https://lore.kernel.org/r/20240624112542.25657-3-avri.altman@wdc.com
Signed-off-by: Ulf Hansson <ulf.hansson@linaro.org>
2024-07-08 11:10:34 +02:00

36 lines
931 B
Plaintext

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
above) to the linux-mmc@vger.kernel.org mailing list with maintainers as
Cc recipients.
Documentation
-------------
https://mmc-utils.readthedocs.io/en/latest/
Maintainers
-----------
Avri Altman <avri.altman@wdc.com>
Ulf Hansson <ulf.hansson@linaro.org>
License
-------
This project is licensed under GPL-2.0-only.