From 4bd2cdc14f7e2fd57897cd9651c2d73c694544f4 Mon Sep 17 00:00:00 2001
From: Bray Moll <bkm82@nau.edu>
Date: Fri, 7 Feb 2025 04:08:53 -0700
Subject: [PATCH] docs: update readme

---
 .github/workflows/{release.yml => cd.yml} |  0
 .github/workflows/test.backup             | 27 -----------------------
 README.org                                | 19 ++++++++++++++--
 3 files changed, 17 insertions(+), 29 deletions(-)
 rename .github/workflows/{release.yml => cd.yml} (100%)
 delete mode 100644 .github/workflows/test.backup

diff --git a/.github/workflows/release.yml b/.github/workflows/cd.yml
similarity index 100%
rename from .github/workflows/release.yml
rename to .github/workflows/cd.yml
diff --git a/.github/workflows/test.backup b/.github/workflows/test.backup
deleted file mode 100644
index 523ad32..0000000
--- a/.github/workflows/test.backup
+++ /dev/null
@@ -1,27 +0,0 @@
-name: Tests
-
-on:
-  - push
-  - pull_request
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Setup Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '3.0'
-    - name: Install Ceedling
-      run: gem install ceedling
-    - name: Install gcovr
-      run: pip install gcovr
-    - name: Run Unit tests
-      run: ceedling gcov:all
-    - name: Upload coverage report to Codecov
-      uses: codecov/codecov-action@v5
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/README.org b/README.org
index 3b5a843..58a86ca 100644
--- a/README.org
+++ b/README.org
@@ -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]]
 
 
@@ -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
@@ -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