Skip to content

Commit 9e33d65

Browse files
committed
add dev section
1 parent 6fc1cf9 commit 9e33d65

File tree

1 file changed

+56
-13
lines changed

1 file changed

+56
-13
lines changed

README.md

+56-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# BioFSharp.ML
1+
# BioFSharp.ML
22

33
![Logo](docs/img/Logo_large.png)
44

@@ -45,19 +45,62 @@ Here is a list of things you should/might want to do after setting up a repo wit
4545
- in `.github/workflows/build-and-test.yml`: change codecov slug
4646
- If needed, change the target framework of the project. it currently targets `.netstandard2.0` for maximum backwards compatibility, might want to target a newer `.net` version if you need a specific API.
4747
48-
## Build
48+
## Development
4949
50-
This repo contains a buildproject that can be called either via `build.cmd`, `build.sh`, or directly via `dotnet run`.
50+
### General
5151
52-
Find all build targets in `build/Build.fs`.
52+
BioFSharp repositories usually folllow this structure:
5353
54-
Examples:
54+
```
55+
root
56+
│ 📄<project name>.sln
57+
│ 📄build.cmd
58+
│ 📄build.sh
59+
├───📁build
60+
├───📁docs
61+
├───📁src
62+
| └───📁<project name>
63+
└───tests
64+
└───📁<testproject name>
65+
```
5566
56-
- run the default build target (`Build`) via build.cmd:
57-
```bash
58-
./build.cmd
59-
```
60-
- run the `RunTests` target in build.sh:
61-
```bash
62-
./build.sh RunTests
63-
```
67+
- <project name>.sln is the root solution file.
68+
- `build` contains a [FAKE](https://fake.build/) build project with targets for building, testing and packaging the project.
69+
- `build/sh` and `build.cmd` in the root are shorthand scripts to execute the buildproject.
70+
- `docs` contains the documentation in form of literate scripts and notebooks.
71+
- `src` contains folders with the source code of the project(s).
72+
- `tests` contains folders with test projects.
73+
74+
### Build
75+
76+
just call `build.sh` or `build.cmd` depending on your OS.
77+
78+
### Test
79+
80+
```bash
81+
build.sh runtests
82+
```
83+
84+
```bash
85+
build.cmd runtests
86+
```
87+
88+
### Create Nuget package
89+
90+
```bash
91+
build.sh pack
92+
```
93+
```bash
94+
build.cmd pack
95+
```
96+
97+
### Docs
98+
99+
You can watch locally with hot reload via
100+
101+
```bash
102+
build.sh watchdocs
103+
```
104+
```bash
105+
build.cmd watchdocs
106+
```

0 commit comments

Comments
 (0)