Skip to content

docs: update readme #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bkm82 merged 1 commit into from
Feb 7, 2025
Merged

docs: update readme #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .github/workflows/release.yml → .github/workflows/cd.yml
View file
Open in desktop
File renamed without changes.
27 changes: 0 additions & 27 deletions .github/workflows/test.backup
View file
Open in desktop

This file was deleted.

19 changes: 17 additions & 2 deletions README.org
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Flow Visualization Code forked from FlowPhysics/flowVC

[[https://github.com/bkm82/flowVC/actions][https://github.com/bkm82/flowVC/actions/workflows/tests.yml/badge.svg]]
[[https://github.com/bkm82/flowVC/actions][https://github.com/bkm82/flowVC/actions/workflows/CI.yml/badge.svg]]
[[https://codecov.io/gh/bkm82/flowVC][https://codecov.io/gh/bkm82/flowVC/graph/badge.svg?token=1U1152BG8T]]


Expand All @@ -18,7 +18,8 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

** Installation
*** Binaries
Currently this project does not have any pre-build binaries, so the code must be build from source. Reference the Development section below. The intent is to implement trunk based development.
This project has a pre-compiled binary for linux in the releases.

*** Development
**** Dependencies
[[https://www.ruby-lang.org/en/][Ruby]] > v 3.0: A programing language used for Ceedling
Expand Down Expand Up @@ -53,5 +54,19 @@ gcovr: a code coverage reporter
ceedling release
#+end_src
this will create the ./build/release/flowVC.out executable




**** Guidlines

***** Semantic Versioning:
This project intends to use a Trunk-Based Release with semantic versioning. Commit messages should follow [[https://www.conventionalcommits.org/en/v1.0.0/][conventional commits]]
#+begin_src shell
<type>[optional scope]: <description>
#+end_src

Where the type determines the version updates.

Valid types are fix, feat, BREAKING CHANGE, build, chore, ci, docs, style, refactor, perf, test