Merge pull request #6 from TypeScriptPlayground/dev

v0.0.3

Author: Katze719

.github/workflows/build.yml

@@ -3,7 +3,7 @@ name: Build Binarys
 on:
   push:
     paths:
-      - 'src/**'
+      - 'cpp/**'
       - '.github/workflows/build.yml'
 
 env:
@@ -28,7 +28,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: linux-binary
-        path: ${{github.workspace}}/build/src/libserialport.so
+        path: ${{github.workspace}}/build/cpp/libserialport.so
 
   build_windows:
     name: Build win64 binaries
@@ -47,7 +47,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: windows-binary
-        path: ${{github.workspace}}\build\src\Release\serialport.dll
+        path: ${{github.workspace}}\build\cpp\Release\serialport.dll
 
   commit:
     needs: [build_windows, build_linux]
@@ -66,13 +66,13 @@ jobs:
           path: ${{github.workspace}}/tmp
 
       - name: Create bin folder if it does not exist
-        run: mkdir -p ${{github.workspace}}/lib/bin
+        run: mkdir -p ${{github.workspace}}/ts/bin
 
       - name: Move and rename linux binary
-        run: mv ${{github.workspace}}/tmp/linux-binary/libserialport.so ${{github.workspace}}/lib/bin/linux.so
+        run: mv ${{github.workspace}}/tmp/linux-binary/libserialport.so ${{github.workspace}}/ts/bin/linux.so
 
       - name: Move and rename windows binary
-        run: mv ${{github.workspace}}/tmp/windows-binary/serialport.dll ${{github.workspace}}/lib/bin/windows.dll
+        run: mv ${{github.workspace}}/tmp/windows-binary/serialport.dll ${{github.workspace}}/ts/bin/windows.dll
 
       - name: Configure Git
         run: |
@@ -81,7 +81,7 @@ jobs:
           
       - name: Commit binaries
         run: |
-          git add ${{github.workspace}}/lib/bin/*
+          git add ${{github.workspace}}/ts/bin/*
           git diff-index --quiet HEAD || git commit -m "Commited compiled binaries"
           
       - name: Push changes

.github/workflows/release.yml

@@ -10,7 +10,7 @@ on:
   pull_request:
     branches: [ "main" ]
     paths:
-      - 'src/**'
+      - 'cpp/**'
       - '.github/workflows/release.yml'
 
 env:
@@ -34,7 +34,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: linux-binary
-        path: ${{github.workspace}}/build/src/libserialport.so
+        path: ${{github.workspace}}/build/cpp/libserialport.so
 
   build_windows:
     runs-on: windows-latest
@@ -52,7 +52,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: windows-binary
-        path: ${{github.workspace}}\build\src\Release\serialport.dll
+        path: ${{github.workspace}}\build\cpp\Release\serialport.dll
 
   pre-release:
     needs: [build_windows, build_linux]
@@ -68,18 +68,18 @@ jobs:
           path: ${{github.workspace}}/tmp
 
       - name: Rename linux Binary
-        run: mv ${{github.workspace}}/tmp/linux-binary/libserialport.so ${{github.workspace}}/lib/bin/linux.so
+        run: mv ${{github.workspace}}/tmp/linux-binary/libserialport.so ${{github.workspace}}/ts/bin/linux.so
 
       - name: Rename windows Binary
-        run: mv ${{github.workspace}}/tmp/windows-binary/serialport.dll ${{github.workspace}}/lib/bin/windows.dll
+        run: mv ${{github.workspace}}/tmp/windows-binary/serialport.dll ${{github.workspace}}/ts/bin/windows.dll
 
       - run: cd ${{github.workspace}}
 
       - name: make .tar.gz file
-        run: tar -czvf SerialLink-lib.tar.gz ./lib
+        run: tar -czvf SerialLink-lib.tar.gz ./ts
 
       - name: make .zip
-        run: zip -r SerialLink-lib.zip ./lib
+        run: zip -r SerialLink-lib.zip ./ts
 
       - uses: "marvinpinto/action-automatic-releases@latest"
         with:

CMakeLists.txt

@@ -6,6 +6,6 @@ project(${PROJECT_N} VERSION 1.0)
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
 
-add_subdirectory(src)
+add_subdirectory(cpp)
 
 target_include_directories(${PROJECT_N} PUBLIC include)

README.md

@@ -1,10 +1,8 @@
 <!-- Badges -->
 [Build binaries]: https://img.shields.io/github/actions/workflow/status/TypeScriptPlayground/Serial/build.yml?label=Build%20binaries&labelColor=343b42&logo=github&logoColor=959DA5 'Build binaries'
-[Release Downloads]: https://img.shields.io/github/downloads/TypeScriptPlayground/Serial/total?label=Downloads%20&labelColor=343b42&logo=docusign&logoColor=959DA5 'Total Release Downloads'
 
 # Serial
 [![Build binaries]](https://github.com/TypeScriptPlayground/Serial/actions/workflows/build.yml)
-[![Release Downloads]](https://github.com/TypeScriptPlayground/Serial/releases)
 
 <a href="https://deno.land"><img align="right" src="https://deno.land/logo.svg" height="150px" alt="the deno mascot dinosaur standing in the rain"></a>
 
@@ -26,7 +24,7 @@ This library provides an interface for the communication with serial devices and
 - Create multiple serial connections at the same time.
 - List available ports and their properties.
 - Set timeouts for both reading and writing.
-- All functions are async.
+- All functions are async (currently not implemented yet).
 - Uses no third party modules.
 - Works on different operating systems (check [compatibility](#compatibility) for mor info).
 
@@ -36,12 +34,6 @@ This library provides an interface for the communication with serial devices and
 | Windows | Windows 10 (x64)        | implemented   |
 | Linux   | Ubuntu Server 22.04 LTS | implemented   |
 
-## Possible/Known issues
-- What happens if you open multiple connections from the same instance.
-- Every function returns the status code although it is previously checked.
-- What happens if you async read 2 times directly after each other.
-- Linux write currently not working
-
 ## Examples - How to use
 To use this library you need the following flags to run it:
 - `--unstable`

src/CMakeLists.txt renamed to cpp/CMakeLists.txt

@@ -25,7 +25,7 @@ MACRO(header_directories return_list includes_base_folder extention )
 ENDMACRO()
 
 # using said macro.
-header_directories(INCLUDES ${PROJECT_SOURCE_DIR}/src/include/ h)
+header_directories(INCLUDES ${PROJECT_SOURCE_DIR}/cpp/include/ h)
 
 message("src files:")
 foreach(file ${SRCS})