From ed2e63425ff13d12f75a41371ee960ae2f7a1593 Mon Sep 17 00:00:00 2001 From: Remi Soummer Date: Thu, 28 Mar 2024 11:21:20 -0400 Subject: [PATCH 1/2] update readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc30c5cdf..14a2a3113 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ +The Control and Automation for Testbeds Kit 2 (CATKit2) +--------------------- +CATKit2 is a toolkit for hardware controls that has been developed at the Space Telescope Science Institute. +It provides a general infrastructure to control hardware and synchronize devices. + +This package was developed for use on the High-contrast Imager for Complex Apertures Testbed (HiCAT) for +developing technologies relevant to direct imaging of exoplanets in astronomy in the laboratory. + +This is an open-source package, but it not actively supported. Use at your own risk. + Environment variables --------------------- @@ -5,7 +15,7 @@ Set `FOR_DISABLE_CONSOLE_CTRL_HANDLER` to `1`. This disables the Fortran Ctrl+C On Windows, you can set environment variables for your account only from the control panel, which doesn't require administrator rights. -On MacOS, assuming a bash shell (the standard choice for hicat work) this is done by adding the following line at the end of your .bash_profile file: +On MacOS, assuming a bash shell this is done by adding the following line at the end of your .bash_profile file: ``` export FOR_DISABLE_CONSOLE_CTRL_HANDLER=1 ``` From 04d07032fa6795704a2a9e355bf46b4e42d97fdf Mon Sep 17 00:00:00 2001 From: Remi Soummer Date: Thu, 4 Apr 2024 12:10:18 -0400 Subject: [PATCH 2/2] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 14a2a3113..5aed91068 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ It provides a general infrastructure to control hardware and synchronize devices This package was developed for use on the High-contrast Imager for Complex Apertures Testbed (HiCAT) for developing technologies relevant to direct imaging of exoplanets in astronomy in the laboratory. -This is an open-source package, but it not actively supported. Use at your own risk. +This is an open-source package, but it is not actively supported. Use at your own risk. Environment variables ---------------------