automatic template update of Modbus Analyzer

saleae · Dec 6, 2023 · 0b2845d · 0b2845d
1 parent da9f879
commit 0b2845d
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 15 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -12,40 +12,40 @@ jobs:
   windows:
     runs-on: windows-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Build
       run: |
         cmake -B ${{github.workspace}}/build -A x64
         cmake --build ${{github.workspace}}/build --config Release
     - name: Upload windows build
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: windows
         path: ${{github.workspace}}/build/Analyzers/Release/*.dll
   macos:
     runs-on: macos-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Build
       run: |
         cmake -B ${{github.workspace}}/build/x86_64 -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES=x86_64
         cmake --build ${{github.workspace}}/build/x86_64
         cmake -B ${{github.workspace}}/build/arm64 -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES=arm64
         cmake --build ${{github.workspace}}/build/arm64
     - name: Upload MacOS x86_64 build
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: macos_x86_64
         path: ${{github.workspace}}/build/x86_64/Analyzers/*.so
     - name: Upload MacOS arm64 build
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: macos_arm64
         path: ${{github.workspace}}/build/arm64/Analyzers/*.so
   linux:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Build
       run: |
         cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=Release
@@ -54,7 +54,7 @@ jobs:
         CC:   gcc-10
         CXX:  g++-10
     - name: Upload Linux build
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: linux
         path: ${{github.workspace}}/build/Analyzers/*.so
@@ -63,14 +63,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: download individual builds
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v3
       with:
         path: ${{github.workspace}}/artifacts
     - name: zip
       run: |
         cd ${{github.workspace}}/artifacts
         zip -r ${{github.workspace}}/analyzer.zip .
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v3
       with:
         name: all-platforms
         path: ${{github.workspace}}/artifacts/**

diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Saleae
+
+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/README.md b/README.md
@@ -4,7 +4,7 @@ Saleae Modbus Analyzer
 
 ## Getting Started
 
-The following documentation describes getting this analyzer building locally. For more detailed information about the Analyzer SDK, debugging, CI build, and more, checkout the readme from the Sample Analyzer repository:
+The following documentation describes how to build this analyzer locally. For more detailed information about the Analyzer SDK, debugging, CI builds, and more, check out the readme in the Sample Analyzer repository.
 
 https://github.com/saleae/SampleAnalyzer
 
@@ -16,15 +16,15 @@ Dependencies:
 - CMake 3.13+
 - git
 
-Installing command line tools after XCode is installed:
+Install command line tools after XCode is installed:
 
 ```
 xcode-select --install
 ```
 
 Then open XCode, open Preferences from the main menu, go to locations, and select the only option under 'Command line tools'.
 
-Installing CMake on MacOS:
+Install CMake on MacOS:
 
 1. Download the binary distribution for MacOS, `cmake-*-Darwin-x86_64.dmg`
 2. Install the usual way by dragging into applications.
@@ -36,7 +36,7 @@ Installing CMake on MacOS:
 
 _Note: Errors may occur if older versions of CMake are installed._
 
-Building the analyzer:
+Build the analyzer:
 
 ```
 mkdir build
@@ -59,7 +59,7 @@ Misc dependencies:
 sudo apt-get install build-essential
 ```
 
-Building the analyzer:
+Build the analyzer:
 
 ```
 mkdir build
@@ -96,7 +96,7 @@ https://cmake.org/download/
 Download and install git here.
 https://git-scm.com/
 
-Building the analyzer:
+Build the analyzer:
 
 ```
 mkdir build
@@ -106,6 +106,12 @@ cmake .. -A x64
 
 Then, open the newly created solution file located here: `build\modbus_analyzer.sln`
 
+Optionally, build from the command line without opening Visual Studio:
+
+```
+cmake --build .
+```
+
 The built analyzer DLLs will be located here:
 
 `build\Analyzers\Debug`