Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 1.87 KB

README.md

File metadata and controls

68 lines (45 loc) · 1.87 KB

My ISO C++ Committee (WG21) papers

This repo contains ISO C++ Committee (WG21) papers that I created or co-authored with other C++ experts.

src directory contains source version of those documents. They are written in markdown-like language. Depending on the file extension the specific paper is using either:

for their processing.

Generated outcome documents can be found on GitHub IO page.

Getting started

Bikeshed

  1. Bikeshed is really simple to install

    git clone https://github.com/tabatkins/bikeshed.git
    pip2 install --editable /path/to/cloned/bikeshed
    bikeshed update
  2. Updating Bikeshed to the latest version and state requires the following steps

    git pull --rebase
    bikeshed update
  3. To develop a document with Bikeshed the most useful is

    bikeshed watch src/paper_to_generate.bs

For more information refer to Bikeshed Documentation.

mpark/wg21

  1. Framework usage is nicely described int the README documentation on the project's website.

markdownlint and VS code

The repository provides a support for markdownlint to ensure that markdown documents are compliant and consistent. To use this feature just install markdownlint plugin in VS Code.

Generating docs

  1. Change the active directory to the src subdirectory
  2. Type make and press TAB to see the list of available targets
  3. Provide the target and press ENTER

For example:

cd src
make 2008R1_enable_variable_template_template_parameters.html