diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..280c7ed --- /dev/null +++ b/LICENSE @@ -0,0 +1,11 @@ +Copyright 2019 Marshall Clyburn + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README.md b/README.md index a23ded4..b9ac7e0 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,19 @@ TI MSP430 User Library ===== A namespace-oriented wrapper library for using the TI MSP430. +This library aims to provide a more straightforward approach to working with the MSP430 MCU and its modules. +Use of `#define` is avoided where possible, instead, favoring constants and inline functions. +C++ namespaces are used to logically divide functionality and modules of the MSP430. + Building ----- +Currently, the library is compiled with GCC 9.1.0 with C++17. + The included makefile in `src` does a little work in finding the correct compiler to use. Change MSP430PATH to the directory where MSP430 files are (bin, lib, include, etc.). Change MSP430MCU to the MCU to compile for. + +License +----- +This library is licensed under the 3-clause BSD License. +See LICENSE for more information.