From 9421d02ad35a5753be31bcee7b80fb7bf9c664e5 Mon Sep 17 00:00:00 2001 From: Toni Klopfenstein Date: Wed, 14 Oct 2015 16:03:04 -0600 Subject: [PATCH] Updating repo structure --- .gitattributes | 22 ++++++++ Firmware/README.md | 3 - LICENSE.md | 55 +++++++++++++++++++ {Firmware => Libraries}/Canbus/Canbus.cpp | 0 {Firmware => Libraries}/Canbus/Canbus.h | 0 {Firmware => Libraries}/Canbus/defaults.h | 0 .../SparkFun_CAN_Demo/SparkFun_CAN_Demo.ino | 0 .../SparkFun_ECU_Demo/SparkFun_ECU_Demo.ino | 0 .../SparkFun_GPS_Demo/SparkFun_GPS_Demo.ino | 0 .../SparkFun_Joystick_Demo.ino | 0 .../SparkFun_SD_Demo/SparkFun_SD_Demo.ino | 0 .../SparkFun_SerialLCD_Demo.ino | 0 {Firmware => Libraries}/Canbus/global.h | 0 {Firmware => Libraries}/Canbus/keywords.txt | 0 {Firmware => Libraries}/Canbus/mcp2515.c | 0 {Firmware => Libraries}/Canbus/mcp2515.h | 0 {Firmware => Libraries}/Canbus/mcp2515_defs.h | 0 Libraries/README.md | 20 +++++++ 18 files changed, 97 insertions(+), 3 deletions(-) create mode 100644 .gitattributes delete mode 100644 Firmware/README.md create mode 100644 LICENSE.md rename {Firmware => Libraries}/Canbus/Canbus.cpp (100%) rename {Firmware => Libraries}/Canbus/Canbus.h (100%) rename {Firmware => Libraries}/Canbus/defaults.h (100%) rename {Firmware => Libraries}/Canbus/examples/SparkFun_CAN_Demo/SparkFun_CAN_Demo.ino (100%) rename {Firmware => Libraries}/Canbus/examples/SparkFun_ECU_Demo/SparkFun_ECU_Demo.ino (100%) rename {Firmware => Libraries}/Canbus/examples/SparkFun_GPS_Demo/SparkFun_GPS_Demo.ino (100%) rename {Firmware => Libraries}/Canbus/examples/SparkFun_Joystick_Demo/SparkFun_Joystick_Demo.ino (100%) rename {Firmware => Libraries}/Canbus/examples/SparkFun_SD_Demo/SparkFun_SD_Demo.ino (100%) rename {Firmware => Libraries}/Canbus/examples/SparkFun_SerialLCD_Demo/SparkFun_SerialLCD_Demo.ino (100%) rename {Firmware => Libraries}/Canbus/global.h (100%) rename {Firmware => Libraries}/Canbus/keywords.txt (100%) rename {Firmware => Libraries}/Canbus/mcp2515.c (100%) rename {Firmware => Libraries}/Canbus/mcp2515.h (100%) rename {Firmware => Libraries}/Canbus/mcp2515_defs.h (100%) create mode 100644 Libraries/README.md diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..412eeda --- /dev/null +++ b/.gitattributes @@ -0,0 +1,22 @@ +# Auto detect text files and perform LF normalization +* text=auto + +# Custom for Visual Studio +*.cs diff=csharp +*.sln merge=union +*.csproj merge=union +*.vbproj merge=union +*.fsproj merge=union +*.dbproj merge=union + +# Standard to msysgit +*.doc diff=astextplain +*.DOC diff=astextplain +*.docx diff=astextplain +*.DOCX diff=astextplain +*.dot diff=astextplain +*.DOT diff=astextplain +*.pdf diff=astextplain +*.PDF diff=astextplain +*.rtf diff=astextplain +*.RTF diff=astextplain diff --git a/Firmware/README.md b/Firmware/README.md deleted file mode 100644 index d80d2b3..0000000 --- a/Firmware/README.md +++ /dev/null @@ -1,3 +0,0 @@ -To use the following example code, you will need to also include the following libraries: - -* **TinyGPS** - Available on GitHub [here](https://github.com/mikalhart/TinyGPS) \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2a52776 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,55 @@ +SparkFun License Information +============================ + +SparkFun uses two different licenses for our files — one for hardware and one for code. + +Hardware +--------- + +**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).** + +Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode). + +You are free to: + +Share — copy and redistribute the material in any medium or format +Adapt — remix, transform, and build upon the material +for any purpose, even commercially. +The licensor cannot revoke these freedoms as long as you follow the license terms. +Under the following terms: + +Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. +ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original. +No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. +Notices: + +You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation. +No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material. + + +Code +-------- + +**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).** + +The MIT License (MIT) + +Copyright (c) 2015 SparkFun Electronics + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Firmware/Canbus/Canbus.cpp b/Libraries/Canbus/Canbus.cpp similarity index 100% rename from Firmware/Canbus/Canbus.cpp rename to Libraries/Canbus/Canbus.cpp diff --git a/Firmware/Canbus/Canbus.h b/Libraries/Canbus/Canbus.h similarity index 100% rename from Firmware/Canbus/Canbus.h rename to Libraries/Canbus/Canbus.h diff --git a/Firmware/Canbus/defaults.h b/Libraries/Canbus/defaults.h similarity index 100% rename from Firmware/Canbus/defaults.h rename to Libraries/Canbus/defaults.h diff --git a/Firmware/Canbus/examples/SparkFun_CAN_Demo/SparkFun_CAN_Demo.ino b/Libraries/Canbus/examples/SparkFun_CAN_Demo/SparkFun_CAN_Demo.ino similarity index 100% rename from Firmware/Canbus/examples/SparkFun_CAN_Demo/SparkFun_CAN_Demo.ino rename to Libraries/Canbus/examples/SparkFun_CAN_Demo/SparkFun_CAN_Demo.ino diff --git a/Firmware/Canbus/examples/SparkFun_ECU_Demo/SparkFun_ECU_Demo.ino b/Libraries/Canbus/examples/SparkFun_ECU_Demo/SparkFun_ECU_Demo.ino similarity index 100% rename from Firmware/Canbus/examples/SparkFun_ECU_Demo/SparkFun_ECU_Demo.ino rename to Libraries/Canbus/examples/SparkFun_ECU_Demo/SparkFun_ECU_Demo.ino diff --git a/Firmware/Canbus/examples/SparkFun_GPS_Demo/SparkFun_GPS_Demo.ino b/Libraries/Canbus/examples/SparkFun_GPS_Demo/SparkFun_GPS_Demo.ino similarity index 100% rename from Firmware/Canbus/examples/SparkFun_GPS_Demo/SparkFun_GPS_Demo.ino rename to Libraries/Canbus/examples/SparkFun_GPS_Demo/SparkFun_GPS_Demo.ino diff --git a/Firmware/Canbus/examples/SparkFun_Joystick_Demo/SparkFun_Joystick_Demo.ino b/Libraries/Canbus/examples/SparkFun_Joystick_Demo/SparkFun_Joystick_Demo.ino similarity index 100% rename from Firmware/Canbus/examples/SparkFun_Joystick_Demo/SparkFun_Joystick_Demo.ino rename to Libraries/Canbus/examples/SparkFun_Joystick_Demo/SparkFun_Joystick_Demo.ino diff --git a/Firmware/Canbus/examples/SparkFun_SD_Demo/SparkFun_SD_Demo.ino b/Libraries/Canbus/examples/SparkFun_SD_Demo/SparkFun_SD_Demo.ino similarity index 100% rename from Firmware/Canbus/examples/SparkFun_SD_Demo/SparkFun_SD_Demo.ino rename to Libraries/Canbus/examples/SparkFun_SD_Demo/SparkFun_SD_Demo.ino diff --git a/Firmware/Canbus/examples/SparkFun_SerialLCD_Demo/SparkFun_SerialLCD_Demo.ino b/Libraries/Canbus/examples/SparkFun_SerialLCD_Demo/SparkFun_SerialLCD_Demo.ino similarity index 100% rename from Firmware/Canbus/examples/SparkFun_SerialLCD_Demo/SparkFun_SerialLCD_Demo.ino rename to Libraries/Canbus/examples/SparkFun_SerialLCD_Demo/SparkFun_SerialLCD_Demo.ino diff --git a/Firmware/Canbus/global.h b/Libraries/Canbus/global.h similarity index 100% rename from Firmware/Canbus/global.h rename to Libraries/Canbus/global.h diff --git a/Firmware/Canbus/keywords.txt b/Libraries/Canbus/keywords.txt similarity index 100% rename from Firmware/Canbus/keywords.txt rename to Libraries/Canbus/keywords.txt diff --git a/Firmware/Canbus/mcp2515.c b/Libraries/Canbus/mcp2515.c similarity index 100% rename from Firmware/Canbus/mcp2515.c rename to Libraries/Canbus/mcp2515.c diff --git a/Firmware/Canbus/mcp2515.h b/Libraries/Canbus/mcp2515.h similarity index 100% rename from Firmware/Canbus/mcp2515.h rename to Libraries/Canbus/mcp2515.h diff --git a/Firmware/Canbus/mcp2515_defs.h b/Libraries/Canbus/mcp2515_defs.h similarity index 100% rename from Firmware/Canbus/mcp2515_defs.h rename to Libraries/Canbus/mcp2515_defs.h diff --git a/Libraries/README.md b/Libraries/README.md new file mode 100644 index 0000000..51a0617 --- /dev/null +++ b/Libraries/README.md @@ -0,0 +1,20 @@ +SparkFun CAN-Bus Libraries +================================= + +Libraries for use in different environments. + +To use some of our examples, you must also include the following: +* **TinyGPS** - Available on GitHub [here](https://github.com/mikalhart/TinyGPS) + +Directory Contents +------------------- +* **/Arduino** - [Arduino IDE](http://www.arduino.cc/en/Main/Software) libraries + + + +Update Library Instructions: +---------------------------- +To get the most up-to-date version of the library, you must run the following git subtree commands. + +$git subtree pull -P Libraries/Arduino --squash git@github.com:sparkfun/SparkFun_CAN-Bus_Arduino_Library.git master +