git.sr.ht: document license and readme names

1 files changed, 26 insertions, 1 deletions

diff --git a/git.sr.ht/index.md b/git.sr.ht/index.md
index 619b04b..3ca034b 100644
--- a/git.sr.ht/index.md
+++ b/git.sr.ht/index.md
@@ -199,7 +199,32 @@ repository. To rename your default branch, use something like the following:
     git branch -m master main
     git push origin :master main:main
 
-# Setting a custom README
+# README and LICENSE files
+
+You may create a README file for your repository which will be displayed on the
+repo summary page, and on a [project hub](https://sr.ht) project if you list
+your project there. The following file names are accepted:
+
+- README
+- README.md
+- README.markdown
+
+The latter two options are rendered as markdown. You may use other formats by
+preparing a custom readme, see the next section for details.
+
+You are also encouraged to add a LICENSE file which details the use and
+distribution terms of your software. The following names are accepted:
+
+- LICENSE
+- COPYING
+- COPYRIGHT
+- LICENSES
+
+If your project has more than one license, your license file should explain what
+licenses apply to what parts of the code in plain English, and include the text
+of all applicable licenses.
+
+## Setting a custom README
 
 By default, if found, a `README` plaintext or `README.md` markdown file
 will be rendered as the repository's README.