From d0d24dd0ad83aaef8be49dbc963140ed9451c357 Mon Sep 17 00:00:00 2001 From: thufie Date: Sun, 25 Jul 2021 08:41:27 +0200 Subject: [PATCH] updated readme with examples --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 941562a..b08ac0d 100644 --- a/README.md +++ b/README.md @@ -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.