BioFSharp.BioContainers

A template repository for creating an extension package for BioFSharp.

Development

General

BioFSharp repositories usually folllow this structure:

root
│   📄<project name>.sln
│   📄build.cmd
│   📄build.sh
├───📁build
├───📁docs
├───📁src
|   └───📁<project name>
└───tests
    └───📁<testproject name>

• .sln is the root solution file.
• build contains a FAKE build project with targets for building, testing and packaging the project.
• build/sh and build.cmd in the root are shorthand scripts to execute the buildproject.
• docs contains the documentation in form of literate scripts and notebooks.
• src contains folders with the source code of the project(s).
• tests contains folders with test projects.

Build

just call build.sh or build.cmd depending on your OS.

Test

build.sh runtests

build.cmd runtests

Create Nuget package

build.sh pack

build.cmd pack

Docs

You can watch locally with hot reload via

build.sh watchdocs

build.cmd watchdocs