From faf60861861adf0b34e9f951f0b919fe5d118ba2 Mon Sep 17 00:00:00 2001 From: nstelter-slac Date: Tue, 20 Feb 2024 14:36:22 -0800 Subject: [PATCH] DOC: update readme, add back in button to see github-actions result --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 0caea19..1ee3eb0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +# beamtime-calibration-suite +[![Build Status](https://github.com/slaclab/beamtime-calibration-suite/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/slaclab/beamtime-calibration-suite/actions/workflows/run-tests.yml) + To run any suite_scripts or use the library in scripts outside the project directory, you need to append the location of your project directory to your PYTHONPATH, for example: ``` export PYTHONPATH="${PYTHONPATH}:~/nolan/repos/beamtime-calibration-suite" @@ -21,6 +24,8 @@ _(documentation on the library functionality is still to come, but example usage * /tests: tests files, can be ran with 'pytest .' from the root project directory _(Currently only test for the fitFunctions library file is running, more tests are to be added)_ +* /data: misc data files from the rixx1003721 scripts directory, saving for now but most files will probably be deleted later + ## Current Status: main branch tag v1.0.0 are the scripts used for the 2/17/24 beamtime