Skip to content

Commit

Permalink
Update Readme with Build tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
omaus committed Jul 21, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 79e5a43 commit 4553f5c
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# FsOboParser

An OBO file format parser, written in F#.

## Usage



## Develop

### Build (QuickStart)

If not already done, install .NET SDK.

In any shell, run `build.cmd <target>` where `<target>` may be
- if `<target>` is empty, it just runs dotnet build after cleaning everything
- `RunTests` to run unit tests
- `RunTestsWithCodeCov` to run unit tests with code coverage
- `ReleaseNotes semver:<version>` where `<version>` may be `major`, `minor`, or `patch` to update RELEASE_NOTES.md
- `Pack` to create a NuGet release
- `PackPrelease` to create a NuGet prerelease
- `BuildDocs` to create docs
- `BuildDocsPrerelease` to create prerelease docs
- `WatchDocs` to create docs and run them locally
- `WatchDocsPrelease` to create prerelease docs and run them locally
- `PublishNuget` to create a NuGet release and publish it
- `PublishNugetPrelease` to create a NuGet prerelease and publish it

0 comments on commit 4553f5c

Please sign in to comment.