From 018b5497bb22838771dcd59e1c5f800e68b547e6 Mon Sep 17 00:00:00 2001 From: Bray Moll Date: Tue, 11 Feb 2025 03:41:38 -0700 Subject: [PATCH 1/2] docs: update readme to point users to pre-compiled binarys --- README.org | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/README.org b/README.org index 9dd52bf..04fc8fc 100644 --- a/README.org +++ b/README.org @@ -40,6 +40,14 @@ You cannot compute FTLE and particle trajectories at the same time. The feature ** Usage *** Quick Start +**** Download or Build the Latest Verison of flowVC + + #+begin_quote + [!Note] + Grab a pre-compiled binary for Windows Linux or macOS [[https://github.com/bkm82/flowVC/releases/latest][here]] + Alternatly build it from source as shown below + #+end_quote + **** Create the input data files #+begin_quote [!Note] @@ -58,17 +66,9 @@ You cannot compute FTLE and particle trajectories at the same time. The feature #+end_quote -**** Download or Build the Latest Verison - - #+begin_quote - [!Note] - For linux, get the pre-compiled binary [[https://github.com/bkm82/flowVC/releases/latest][here]] - For windos and mac, see below how to compile the code from source - #+end_quote - -**** Run the code +**** Run the code from the command line #+begin_src shell -./flowvc.out settings_file +./flowvc.out settings_file.in #+end_src **** Report any Issues @@ -77,7 +77,7 @@ You cannot compute FTLE and particle trajectories at the same time. The feature ** Installation *** Build From Source -If you are not on ubuntu, or you want to edit / modify the code, there are various ways to compile the code from source. +If you want to edit / modify the code, there are various ways to compile the code from source. **** Ceedling @@ -118,7 +118,10 @@ If you are not on ubuntu, or you want to edit / modify the code, there are vario **** Docker Alternatly, there is a docker image has the tooling installed. - + #+begin_quote + [!Warning] + The method shown here should work, but i havent tested it extensivly. + #+end_quote ***** Install [[https://docs.docker.com/engine/install/][Docker]] ***** Clone the repository @@ -148,11 +151,6 @@ Alternatly, there is a docker image has the tooling installed. #+end_src ***** This will create the ./build/release/flowVC.out executable. - #+begin_quote - [!Warning] - This method compiles the code using a linux (Ubuntu) docker container, if you you are on another operating system, you might need to run the program through that docker container - #+end_quote - #+begin_src shell docker run -it --rm -v .:/home/dev/project throwtheswitch/madsciencelab:latest .build/release/flowVC.out From 883681e8e3692cef17e50ab1ed2ffbe40b604b3a Mon Sep 17 00:00:00 2001 From: Bray Moll Date: Tue, 11 Feb 2025 03:42:38 -0700 Subject: [PATCH 2/2] docs: remove the completed plan to add windows to the CI/CD pipeline --- README.org | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.org b/README.org index 04fc8fc..75689e7 100644 --- a/README.org +++ b/README.org @@ -176,4 +176,4 @@ Valid types are fix, feat, BREAKING CHANGE, build, chore, ci, docs, style, refac *** Planned Updates -**** TODO Add support for windows in the CI/CD pipeline +