You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+56-13
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# BioFSharp.ML
1
+
# BioFSharp.ML
2
2
3
3

4
4
@@ -45,19 +45,62 @@ Here is a list of things you should/might want to do after setting up a repo wit
45
45
- in `.github/workflows/build-and-test.yml`: change codecov slug
46
46
- 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.
47
47
48
-
## Build
48
+
## Development
49
49
50
-
This repo contains a buildproject that can be called either via `build.cmd`, `build.sh`, or directly via `dotnet run`.
50
+
### General
51
51
52
-
Find all build targets in `build/Build.fs`.
52
+
BioFSharp repositories usually folllow this structure:
53
53
54
-
Examples:
54
+
```
55
+
root
56
+
│ 📄<projectname>.sln
57
+
│ 📄build.cmd
58
+
│ 📄build.sh
59
+
├───📁build
60
+
├───📁docs
61
+
├───📁src
62
+
| └───📁<projectname>
63
+
└───tests
64
+
└───📁<testprojectname>
65
+
```
55
66
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.
0 commit comments