diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 00000000..233b44ad --- /dev/null +++ b/.github/README.md @@ -0,0 +1,24 @@ +Builder | State +:--- | ---: +Documentation | [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FtLDP%2FLDP%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/tLDP/LDP/goto?ref=master) +Pull Requests | [![Build Status](https://drone.tldp.org/api/badges/tLDP/LDP/status.svg)](https://drone.tldp.org/tLDP/LDP) + +--- + +![LDP Logo](https://tldp.org/images/ldp.gif) + +# The LDP: https://tldp.org/ + +**The Linux Documentation Project** is a loosely knit team of volunteers who provide documentation for many aspects of Linux. There are several forms of documentation: Guides, HOWTOs, man pages, and FAQs. + +## Participation + +Please take a part in our efforts. + +* Fork our repository +* Update documents and/or correct/extend existing ones in your forked repository +* Submit a Pull Request (if you do not know how, read for example: https://yangsu.github.io/pull-request-tutorial/) +* Check if our builder successfully renders your submission - if not, check why and resubmit +* Check if your document is correctly rendered on https://tldp.org/test/ after builder shows you green light - if not, check why and resubmit +* One of our admins will review your work +* Publication on https://tldp.org/ is live :+1: