os/npl-builder
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

updated readme with examples

Browse source
This commit is contained in:
thufie 2021-07-25 08:41:27 +02:00
parent 48da3b4240
commit d0d24dd0ad
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -31,7 +31,7 @@ Use this license header in your source files if you want:
## Contributing:
- Only make or propose edits to the license text in template.xml
- Only make or propose edits to the license text in **template.xml**
- Changes that are not common among license have some special formatting requirements. Check the output of `make` to ensure everything is removed from the licenses it does not apply to.
- If a change only applies to the CNPL or CNPL-NA use the "restriction-cooperative" role attribute
- If a change only applies to the CNPL or NPL (or in other words, it has to do with requiring attributions) use the "restriction-attribution" role attribute.
@ -46,3 +46,7 @@ Use this license header in your source files if you want:
## Example Usage:
- `make all` - (re)generate all license markdown files from template.xml
- Use `pandoc` to convert the license into the format of your choice. Use `pandoc --list-output-formats` for a list of available document formats. Try some of these:
- `pandoc -f markdown -t pdf -s -o cnpl.pdf cnpl.md` - Build a pdf of the CNPL (requires `texlive-core`)
- `pandoc -f markdown -t odt -s -o cnpl.odt cnpl.md` - Convert the license to an odt file and open it for spell and grammar check in LibreOffice.
- `pandoc -f markdown -t plain -s -o cnpl.txt cnpl.md` - Produce a plaintext version of the license.