Unified Library & CMake OS Conditional Check

StenoByte Core & Helper files are now compiled and included as a library called "StenoByte_Library".
Moved Core & Helper Files to a new directory called "includes".
CMakeLists.txt is now configured to check the OS the application is being built for and to change it accordingly.
Minor updates to README.

Author: RedHoodedWraith

CMakeLists.txt

@@ -3,13 +3,41 @@ project(StenoByte_Prototype C)
 
 set(CMAKE_C_STANDARD 23)
 
-find_package(PkgConfig REQUIRED)
-pkg_search_module(LIBEVDEV REQUIRED libevdev)
-
-add_executable(StenoByte_Prototype main.c
-        StenoByte_Helper_for_Linux.c
-        StenoByte_Helper.h
-        StenoByte_Core.c
-        StenoByte_Core.h)
-target_include_directories(StenoByte_Prototype PRIVATE ${LIBEVDEV_INCLUDE_DIRS})
-target_link_libraries(StenoByte_Prototype PRIVATE ${LIBEVDEV_LIBRARIES})
+# Linux Variant
+if (LINUX)
+    # Finds Libevdev Library
+    find_package(PkgConfig REQUIRED)
+    pkg_search_module(LIBEVDEV REQUIRED libevdev)
+
+    # Prints Location of Libevdev Library
+    message(STATUS "libevdev include dirs: ${LIBEVDEV_INCLUDE_DIRS}")
+    message(STATUS "libevdev libraries: ${LIBEVDEV_LIBRARIES}")
+
+    ## StenoByte Library for Linux Library
+    add_library(StenoByte_Library STATIC
+            includes/StenoByte_Helper_for_Linux.c
+            includes/StenoByte_Core.c)
+    target_include_directories(StenoByte_Library PRIVATE
+            ${LIBEVDEV_INCLUDE_DIRS}
+            includes)
+    target_link_libraries(StenoByte_Library PRIVATE ${LIBEVDEV_LIBRARIES})
+
+# MacOS Variant
+elseif (APPLE)
+    message(FATAL_ERROR "Unfortunately StenoByte is not yet compatible with MacOS,
+     but support for MacOS is in the works!")
+
+# Windows Variant
+elseif (WIN32)
+    message(FATAL_ERROR "Unfortunately StenoByte is not yet compatible with Windows,
+    but support for Windows is in the works!")
+
+# Throws an error if system is incompatible
+else ()
+    message(FATAL_ERROR "Unfortunately your system is not compatible with StenoByte")
+endif ()
+
+# Main App
+add_executable(StenoByte_Prototype main.c)
+target_include_directories(StenoByte_Prototype PRIVATE ${LIBEVDEV_INCLUDE_DIRS} StenoByte_Library)
+target_link_libraries(StenoByte_Prototype PRIVATE ${LIBEVDEV_LIBRARIES} StenoByte_Library)

README.md

@@ -2,13 +2,13 @@
 A stenotype inspired terminal app for typing out bytes quickly.
 
 This program is designed to allow you to build up a byte using eight keys from your keyboard, with each key 
-corresponding to a bit in a byte (which is made up of eight bits). When you press & hold down those keys, their 
+corresponding to a bit in a byte (which is made up of eight bits). When you press and hold down those keys, their 
 associated bits are set to 1. When the keys are released or are not being pushed, their associated bits are set to 0.
 
-When you are ready to turn those bits into a byte, press the Space Bar and the application will convert those bits into
+When you are ready to turn those bits into a byte, press the Space Bar, and the application will convert those bits into
 a byte and display it as a decimal.
 
-This application is currently designed to work in Linux. 
+This application is currently designed to work on Linux. 
 
 For the time-being, this app requires elevated privileges (e.g. `sudo`) to run.
 
@@ -40,6 +40,11 @@ sudo apt -y install build-essential cmake git libevdev-dev
 sudo pacman -S gcc cmake git libevdev
 ````
 
+#### Install Dependencies on Alpine
+```shell
+apk add --update build-base 'cmake>3.30' libevdev libevdev-dev gdb
+```
+
 ### Step 2: Clone this repository
 Run: 
 ```shell
@@ -80,5 +85,5 @@ maintaining this repository.
 ## License
 Copyright (C) 2025  Asami De Almeida
 
-Released under the Apache License 2.0 License. See the following pages for more information:
-* [Apache License 2.0](LICENSE)
+Released under the Apache Licence 2.0 Licence. See the following pages for more information:
+* [Apache Licence 2.0](LICENSE)

StenoByte_Core.c includes/StenoByte_Core.cStenoByte_Core.c renamed to includes/StenoByte_Core.c

@@ -51,7 +51,7 @@ void compute_byte() {
  */
 void setup_subvalues_array() {
     for (int i = BITS_ARR_SIZE; i >= 0; i--) {
-        constexpr u_int8_t val = 0;
+        const u_int8_t val = 0;
         subvalues_arr[i] = val ^ 1 << i;
     }
 }

StenoByte_Core.h includes/StenoByte_Core.hStenoByte_Core.h renamed to includes/StenoByte_Core.h

@@ -16,7 +16,7 @@
    limitations under the License.
  */
 
-#include "StenoByte_Core.h"
+#include "includes/StenoByte_Core.h"
 
 
 int main() {