SDK diet and license text improved (#127)

- Exclude unnecessary binaries
- Better license wording

Buildscripts/CMake/CMakeLists.txt

@@ -1,17 +1,9 @@
 idf_component_register(
-    INCLUDE_DIRS "Libraries/Tactility/Include" "Libraries/lvgl/Include"
+    INCLUDE_DIRS "Libraries/TactilityC/Include" "Libraries/lvgl/Include"
 )
 
-add_prebuilt_library(Tactility Libraries/Tactility/Binary/libTactility.a)
-add_prebuilt_library(TactilityC Libraries/Tactility/Binary/libTactilityC.a)
-add_prebuilt_library(TactilityCore Libraries/Tactility/Binary/libTactilityCore.a)
-add_prebuilt_library(TactilityHeadless Libraries/Tactility/Binary/libTactilityHeadless.a)
-add_prebuilt_library(elf_loader Libraries/elf_loader/Binary/libelf_loader.a)
+add_prebuilt_library(TactilityC Libraries/TactilityC/Binary/libTactilityC.a)
 add_prebuilt_library(lvgl Libraries/lvgl/Binary/liblvgl.a)
 
 target_link_libraries(${COMPONENT_LIB} INTERFACE TactilityC)
-target_link_libraries(${COMPONENT_LIB} INTERFACE Tactility)
-target_link_libraries(${COMPONENT_LIB} INTERFACE TactilityHeadless)
-target_link_libraries(${COMPONENT_LIB} INTERFACE TactilityCore)
 target_link_libraries(${COMPONENT_LIB} INTERFACE lvgl)
-target_link_libraries(${COMPONENT_LIB} INTERFACE elf_loader)

Buildscripts/release-sdk.sh

@@ -15,12 +15,9 @@ library_path=$target_path/Libraries
 
 cp version.txt $target_path
 
-# Tactility
-tactility_library_path=$library_path/Tactility
+# TactilityC
+tactility_library_path=$library_path/TactilityC
 mkdir -p $tactility_library_path/Binary
-cp build/esp-idf/Tactility/libTactility.a $tactility_library_path/Binary/
-cp build/esp-idf/TactilityCore/libTactilityCore.a $tactility_library_path/Binary/
-cp build/esp-idf/TactilityHeadless/libTactilityHeadless.a $tactility_library_path/Binary/
 cp build/esp-idf/TactilityC/libTactilityC.a $tactility_library_path/Binary/
 mkdir -p $tactility_library_path/Include
 find_target_dir=$build_dir/$tactility_library_path/Include/
@@ -43,9 +40,8 @@ cp Libraries/lvgl_conf/lv_conf_kconfig.h $lvgl_library_path/Include/lv_conf.h
 
 # elf_loader
 elf_loader_library_path=$library_path/elf_loader
-mkdir -p $elf_loader_library_path/Binary
-cp -r Libraries/elf_loader/elf_loader.cmake $elf_loader_library_path
-cp -r build/esp-idf/elf_loader/libelf_loader.a $elf_loader_library_path/Binary
+mkdir -p $elf_loader_library_path
+cp -r Libraries/elf_loader/elf_loader.cmake $elf_loader_library_path/
 
 cp Buildscripts/CMake/TactilitySDK.cmake $target_path/
 cp Buildscripts/CMake/CMakeLists.txt $target_path/

COPYRIGHT.md

@@ -1,12 +1,6 @@
 # Tactility
 
-The Tactility logo copyrights are owned by Ken Van Hoeylandt.
-Firmwares built from [the original repository](https://github.com/ByteWelder/Tactility) can be redistributed with the Tactility logo.
-For other usages, [contact me](https://kenvanhoeylandt.net).
-
-The Tactility project is published under [GPL License Version 3](./LICENSE.md).
-
-The TactilitySDK project is published under an [MIT License](./LICENSE.md).
+See [LICENSE.md](LICENSE.md)
 
 # Dependencies 
 

ExternalApps/HelloWorld/CMakeLists.txt

@@ -6,7 +6,7 @@ if (DEFINED ENV{TACTILITY_SDK_PATH})
     set(TACTILITY_SDK_PATH $ENV{TACTILITY_SDK_PATH})
 else()
     set(TACTILITY_SDK_PATH "../../release/TactilitySDK")
-    message(WARNING "⚠️ TACTILITY_SDK_PATH environment variable is not set, defaulting to ${TACTILITY_PATH}")
+    message(WARNING "⚠️ TACTILITY_SDK_PATH environment variable is not set, defaulting to ${TACTILITY_SDK_PATH}")
 endif()
 
 include("${TACTILITY_SDK_PATH}/TactilitySDK.cmake")

ExternalApps/HelloWorld/build.sh

@@ -1,4 +1,4 @@
 rm sdkconfig
 cp ../../sdkconfig sdkconfig
 cat sdkconfig.override >> sdkconfig
-idf.py build
+idf.py elf_app

LICENSE.md

@@ -1,16 +1,15 @@
 # Tactility
 
-The Tactility project as a whole is licensed under the [GNU General Public License v3](Documentation/license-tactility.md).
+The Tactility project is available under the [GNU General Public License v3](Documentation/license-tactility.md).
 Distributions and forks must adhere to the license terms.
 
-# TactilitySDK
+The Tactility logo copyrights are owned by Ken Van Hoeylandt.
+Firmwares built from [the original repository](https://github.com/ByteWelder/Tactility) can be redistributed with the Tactility logo.
+For other usages, [contact me](https://kenvanhoeylandt.net).
 
-The TactilitySDK distribution files are licensed under an [MIT License](Documentation/license-tactilitysdk.md).
+# TactilityC & TactilitySDK
 
-The Tactility binaries themselves are bound to the GPL v3 license.
-Third party application binaries that compile with the SDK do not include the SDK binaries itself, so they are not bound to this GPL license.
-
-All scripts and Tactility headers in the SDK are licensed under the MIT License.
+TactilityC (source & binaries) and the TactilitySDK distribution files are available under an [MIT License](Documentation/license-tactilitysdk.md).
 
 # Other licenses & copyrights
 
@@ -18,5 +17,5 @@ See [COPYRIGHT.md](COPYRIGHT.md).
 
 # FAQ
 
-- Q: Can I build closed source and/or for-profit applications?
+- Q: Can I build closed source applications?
 - A: Yes, but only if you build them as external apps with the TactilitySDK. Internal apps are part of the OS and currently remain licensed under GPL v3.

TactilityC/CMakeLists.txt

@@ -9,7 +9,8 @@ if (DEFINED ENV{ESP_IDF_VERSION})
     idf_component_register(
         SRCS ${SOURCE_FILES}
         INCLUDE_DIRS "Source/"
-        REQUIRES Tactility TactilityCore TactilityHeadless lvgl elf_loader
+        REQUIRES lvgl
+        PRIV_REQUIRES Tactility TactilityCore TactilityHeadless elf_loader
     )
 
     add_definitions(-DESP_PLATFORM)
@@ -38,7 +39,7 @@ else()
         PRIVATE Tactility
         PRIVATE TactilityCore
         PRIVATE TactilityHeadless
-        PRIVATE lvgl
+        PUBLIC lvgl
     )
 endif()