README / License
Last updated
The README and the license are documents a project can hold. Both are written in Markdown. When you open the screen it shows only the body; when you switch to editing, an Edit tab for writing and a Preview tab for checking the result appear.
README
Section titled “README”The README is the document that describes the contents of the project. You write it on the README screen in the left menu.
License
Section titled “License”The license is the document that communicates the terms under which others may use and share the project and its data. You write it on the License screen in the left menu. When you choose one of the provided templates, the body is replaced with that template. The terms written in the license do not change the project’s visibility or its API access. You switch the visibility on the Settings screen.
License templates
Section titled “License templates”There are nine templates, and you choose one of them.
- Open Use of Data Agreement v1.0
- European Union Public License v1.2
- GNU Lesser General Public License v3.0
- GNU General Public License v3.0
- Apache License 2.0
- MIT License
- Creative Commons Attribution-NonCommercial 4.0 International
- Creative Commons Attribution-ShareAlike 4.0 International
- Creative Commons Attribution 4.0 International