DaveSeidel/csound-floss

The Csound FLOSS Manual

Building

# first install npm dependencies
yarn
# then build with
yarn build

Requirements

• pandoc 2.3+
• nodejs 12_0x
• yarn

Developing

# first install npm dependencies
yarn
# then start writing the book (this will auto-reload any change in the browser)
yarn start

Tests

To run tests locally:

# Recommended
yarn test

# Alternatively (either)
npx jest
yarn jest

# Avoid those two
yarn add jest --global && jest
npm i jest --globall && jest

Contributing

• Conventions for writing
• Writing in Markdown
• Todo list

Writing Tools

• Panwriter: a GUI for editing Pandoc files
• Atom Package for Pandoc edit and preview
• Emacs Mode for editing Pandoc files
• Vim plugin for Pandoc integration and utilities

Further Read

• Pandoc Official Manual
• Pandoc alternative manual

Continuous Integration and Firebaseapp Build

After each merge into develop, a preview of the manual is built and hosted as from firebase, it's available at: https://csound-floss-dev.firebaseapp.com/.