From d54c5404a8101c0cbe4f5b243ff09f4727982084 Mon Sep 17 00:00:00 2001 From: Morgan Redfield Date: Sat, 27 Aug 2016 09:36:01 -0700 Subject: [PATCH] clarify new library setup --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fa351c3..e758ff6 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ # HamShield -WARNING: The dev branch is not guaranteed to work. Please use caution if you choose to use that branch. - -All of the AFSK, DDS, etc. files have been moved to the in Progress directory. These files collectively use twice as much memory as the essential HamShield functions. The current plan is to make sure these are only included if they're going to be used. We'll also be adapting them to make them more friendly to non-Uno Arduinos. Stay tuned for those changes. - The master branch is intended for use with HamShield hardware -09 and above. -HamShield Arduino Library and Example Sketches +WARNING: The dev branch is not guaranteed to work. Please use caution if you choose to use that branch. + +# HamShield Arduino Library and Example Sketches This repository is meant to be checked out into your Arduino application's libraries folder. After reloading the application, the library and example sketches should be available for use. For overview, help, tricks, tips, and more, check out the wiki: -https://github.com/EnhancedRadioDevices/HamShield/wiki \ No newline at end of file +https://github.com/EnhancedRadioDevices/HamShield/wiki + +# KISS and AFSK + +We've moved the KISS and AFSK code to a separate library to help keep memory usage in simple sketches down. To use the AFSK examples, please also install these libraries: + +- https://github.com/EnhancedRadioDevices/DDS +- https://github.com/EnhancedRadioDevices/HamShield_KISS +