diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..c8d7bd3 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true +[*] +end_of_line = lf +insert_final_newline = true +charset = utf-8 + +[*.md] +indent_style = space + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..43ced20 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.DS_Store +dist + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..11be340 --- /dev/null +++ b/Makefile @@ -0,0 +1,32 @@ +# Generate documents in the desired output formats. + +# Identify source and target files. +destination=dist/ +exclusions:=README.md +sources:=$(filter-out $(exclusions), $(wildcard *.md)) +html_targets:=$(patsubst %.md, $(destination)%.html, $(sources)) +pdf_targets:=$(patsubst %.md, $(destination)%.pdf, $(sources)) +docx_targets:=$(patsubst %.md, $(destination)%.docx, $(sources)) + +# Options +pandoc_options:=-s -N + +# Implicit rules +$(destination)%.html : %.md $(destination) + pandoc $(pandoc_options) $< -o $@ +$(destination)%.pdf : %.md $(destination) + pandoc $(pandoc_options) $< -o $@ +$(destination)%.docx : %.md $(destination) + pandoc $(pandoc_options) $< -o $@ + +# Targets +.PHONY: all html pdf docs clean +all: html pdf docx +html: $(html_targets) +pdf: $(pdf_targets) +docx: $(docx_targets) +clean: + rm -rf $(destination) +$(destination): + mkdir -p $(destination) + diff --git a/README.md b/README.md index 8d958e3..1a6bbf4 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -# trust-meter \ No newline at end of file +# Trust meter Documents +This repository contains work of the Trust meter Technical Committee. + +# Software Prerequisites +Documentation is written in Pandoc Markdown. Pandoc and GNU Make are required to build rendered versions using the included makefile. A TeX installation is also necessary if PDF output is desired. HTML, PDF and Office Open XML/Microsoft Word format are generated by default when `make` is run. + +If TeX is not installed and PDF output is not considered necessary, you can run `make -k` to continue processing the makefile despite the failure of the PDF target. + +# Copyright +[Add license details and copyright information.] +