Contributing to floWeaver

Contributions are welcome! Please get in touch via email or creating a GitHub issue with any questions.


These are draft guidelines for getting started contributing to the documentation on Windows. Improvements are welcome, or get in touch if you need better instructions.

  1. Required software: Anaconda, Github Desktop App.

    1. Install pandoc package.
      1. Clone Github Repository using the following URL:

  2. Modify Content. The content is kept in the /docs directory. Each page is saved as a text file formatted in reStructured Text.

  3. Save Modifications. To save the changes made to the content, open the Anaconda Prompt, go to the /floweaver/docs directory and run

    make.bat html