Skip to content

Latest commit

 

History

History
37 lines (21 loc) · 1.45 KB

File metadata and controls

37 lines (21 loc) · 1.45 KB

ecoCode rules specification repository

Description

This project contains the technical specifications of the ecoCode rules for Android.

To build the documentation please install pandoc and a LaTeX engine (for pdf).

How to specify a rule

To learn how to specify a rule, please follow the documentation:

All the existing rules can be found in the rules folder.

Here is the an example of a complete rule specification: Uncompressed Data Transmission

How to build

HTML

Use the following pandoc command line to build the html document in build/html.

pandoc -s -c ecocode-rules.css --toc --metadata title="Environment and Social Smells For Android" -o build/html/doc.html **/*.md */*/*.md && cp ecocode-rules.css build/html/

PDF

Use the following pandoc command line to build the pdf document in build/pdf.

pandoc -s -V geometry:margin=1in --toc -o build/pdf/doc.pdf **/*.md */*/*.md