Skip to content

TelecomixSyria/cryptoparty-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Quickstart example to build the memo_basics.pdf file (requires pandoc
and pdflatex):
cd doc-build/
./build.sh memo_basics

This repository is aimed at containing documents that can help in
events such as cryptoparties. For instance:

- memos with where to download appropriate software and how to use
  some core functionalities (e.g. fingerprint checking);
- slides meant at explaining things in a simple way for beginners.

We shall use Markdown for both documents and slides, since pandoc
can produce both. As much as possible, pictures should also use a git-
friendly format such as SVG.

The repo tries to have a structure that eases translation of the
content into any number of languages. It is probably a very sub-
optimal structure, but here is how it is organized:

- the content-parts/ directory contains directories of language code
  which themselves contain actual pieces of documents content.
- the doc-build/ directory contains a script that takes a document
  name and a language as argument (defaults to 'en', English), and
  files describing a document. Such a file is simply a list of files
  contained in content-parts/$LANGUAGE/. The script concatenates the
  files in the order specified and processes the whole of it through
  pandoc, to create a PDF file.

Hopefully, the splitting in small pieces of content should help for:

- producing translations
- making modular documents by selecting particular pieces from the
  content.

It is deliberate that some documents show URLs in a non-link format,
because we want them to be displayed when printed from a PDF.

About

Documents for CryptoParty-like events

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages