diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 688078f..8cd8b25 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -1,22 +1,17 @@ name: Go on: - push: - branches: [ main ] - pull_request: - branches: [ main ] - + release: + types: [created] jobs: release-linux-amd64: name: release linux/amd64 runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - name: compile and release - uses: ngs/go-release.action@v1.0.1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - GOARCH: amd64 - GOOS: linux - EXTRA_FILES: "README.md LICENSE" - + - uses: actions/checkout@v2 + - uses: wangyoucao577/go-release-action@v1.11 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + goos: linux + goarch: amd64 + extra_files: LICENSE README.md \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2be43cd --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 David Suarez + +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 index 776b2de..a24aa68 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,16 @@ In the future I may try to add an auto-detection of this. For now this was quick ## Running the tool Once you have NodeJS set up, simply download the bs-patch tool from the Releases section -of this repository and execute it: +of this repository, create your config.yaml file, and then execute the tool: + +1. Download the release +2. Extract the bs-patch binary +3. Execute `which npm` +4. Copy the path to the `bin` folder +5. Create a file named `config.yaml` in the same folder as the `bs-patch` binary +6. Execute `./bs-patch` +7. (hopefully) Enjoy your new BluOS Controller app on Linux + ``` $ ./bs-patch