-
Notifications
You must be signed in to change notification settings - Fork 3
Add build infrastructure and update the document with stylistic changes. #59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
37f4aff
feat: create markdown version of the trust meter indroduction google doc
klown 30314d7
Ignore generated files.
jasonjgw 38351a7
Add a basic makefile to generate HTML, PDF and Office Open XML/Microsoft
jasonjgw 6b6d83b
Add title and author metadata.
jasonjgw 67cc939
Use separator (<HR>) syntax accepted by Pandoc.
jasonjgw d675cb2
Add editorconfig file.
jasonjgw 5023fdf
Convert the document to Markdown again, this time without line wrapping.
jasonjgw 676227f
Add title again after file format conversion.
jasonjgw f470037
Enable section numbering for ease of reference. Clarify the makefile.
jasonjgw bc744a2
Correct heading levels in the Definitions section.
jasonjgw 5982d49
Use correct separator markup in the cover note.
jasonjgw 71365ff
Refine makefile by implementing the more useful suggestions in a code
jasonjgw 46a2dcd
Update README to document the build process.
jasonjgw 76c444a
Ignore .DS_Store directory created on macOS systems.
jasonjgw 8964faa
Remove the draft, which will be maintained in a separate branch until…
jasonjgw 71319c7
Place generated files in an output directory.
jasonjgw 3d15b91
Actually create the destination directory, and remove it when cleaning.
jasonjgw b06ecdc
Simplify directory creation.
jasonjgw d1762b0
Suppress make errors if the destination directory already exists.
jasonjgw b3379e6
Document how to continue processing the makefile if TeX (needed for PDF
jasonjgw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| root = true | ||
| [*] | ||
| end_of_line = lf | ||
| insert_final_newline = true | ||
| charset = utf-8 | ||
|
|
||
| [*.md] | ||
| indent_style = space | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| .DS_Store | ||
| dist | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,11 @@ | ||
| # trust-meter | ||
| # 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. | ||
|
klown marked this conversation as resolved.
|
||
|
|
||
| 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.] | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.