Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: docs and ci #28

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 24 additions & 8 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,51 @@
name: Continuous Integration
on: [push, pull_request]

on:
push:
branches:
- "master"

pull_request:
branches:
- "master"

jobs:
build:
strategy:
matrix:
os: [windows, macos]
build-type: [Release, Debug]

name: ${{matrix.os}}/${{matrix.build-type}}
runs-on: ${{matrix.os}}-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- name: Make build directory
run: cmake -E make_directory build

- name: Configure
working-directory: build
run: |
cmake ../Sources \
-DCMAKE_BUILD_TYPE=${{matrix.build-type}}
shell: bash

- name: Compile
working-directory: build
run: cmake --build . --config ${{matrix.build-type}}

- name: Upload binary (Mac)
if: matrix.os == 'macos'
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v4
with:
name: cpu-${{matrix.build-type}}
path: build/cpu

- name: Upload binary (Windows)
if: matrix.os == 'windows'
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v4
with:
name: cpu-${{matrix.build-type}}.exe
path: build/${{matrix.build-type}}/cpu.exe
strategy:
matrix:
os: [windows, macos]
build-type: [Release, Debug]
28 changes: 6 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,11 @@
<div align="center">

`CPU` is a sample plugin demonstrating the [Stream Deck SDK](https://developer.elgato.com/documentation/stream-deck/).
[![](screenshot.png)](https://marketplace.elgato.com/product/cpu-58f3a1f4-dd4d-43bb-9b79-ec95700568a4)

# CPU Stream Deck Plugin

# Description
[![](marketplace-badge.png)](https://marketplace.elgato.com/product/cpu-58f3a1f4-dd4d-43bb-9b79-ec95700568a4)

`CPU` is a plugin that displays the CPU usage on a key.
</div>


# Features

- code written in C++
- cross-platform (macOS, Windows)
- localized


![](screenshot.png)


# Installation

In the Release folder, you can find the file `com.elgato.cpu.streamDeckPlugin`. If you double-click this file on your machine, Stream Deck will install the plugin.


# Source code

The Sources folder contains the source code of the plugin.
Monitor your processor in real time, direct from Stream Deck. With a single key, track CPU utilization across your system. No more surprise lag while streaming, gaming, or designing. Instead, detect usage spikes as they occur and manage your hardware on the fly.
2 changes: 1 addition & 1 deletion Sources/com.elgato.cpu.sdPlugin/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"Name": "CPU",
"Icon": "pluginIcon",
"URL": "https://www.elgato.com/gaming/stream-deck",
"Version": "1.4",
"Version": "1.4.1.0",
"OS": [
{
"Platform": "mac",
Expand Down
Binary file added marketplace-badge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.