frenchmatthew / bioengineering-toolbox

Bioengineering-toolbox

Synopsis

This project is aimed at collecting tips and tricks for bioengineering researchers.

Motivation

The repository was created to provide a first stop, toolbox that answers 'how-to' style questions that researchers find themselves asking while working on bioengineering projects. The aim is for researchers to contribute to this toolbox to create a rich database that everyone would benefit from.

Accessing the tutorial online

This tutorial is hosted on Readthedocs - https://bioengineering-toolbox.readthedocs.io

Building the tutorial locally

1. Clone the repository to your local machine.

2. Navigate to the docs/

3. Issue the command: make html

4. Open the index.html file in docs/build/ folder

Contributing to this tutorial

1. Fork this repository to your github account.

2. Edit the Markdown (.md) files in the docs/sources folder. The files can be edited directly using the file editing tools provided by github. This will allow you to commit your changes to the repository. See the Markdown FAQ section of the documentation for more information on how to write documentation using Markdown.

3. Make a pull request from your fork to the master branch of the main bioengineering-toolbox github repository.

4. Your changes will be reviewed and pulled into the main bioengineering-toolbox github repository.

Over time, your fork may become out of sync with the master branch of the main bioengineering-toolbox github repository. Create a pull request on your fork to pull in changes from the master branch of main bioengineering-toolbox github repository to get your fork back up-to-date. This can be performed directly on the github website.

License

GNU Public License