ripnet / streamdeck-hubitat

Hubitat integration for the Elgato Stream Deck
MIT License
22 stars 8 forks source link

Helpful edits to the readme #4

Open shawnhank opened 3 years ago

shawnhank commented 3 years ago

Hi, there.

Thanks for doing the work to create this integration!

In the Stream Deck section of the readme, the steps jump from downloading your awesome package right to the plugin showing up in the StreamDeck app.

In a show of my genuine appreciation, I've outlined the process to get your code into the Stream Deck app, along with the a link to the official Elgato Developer Docs that I used to successfully install your app.

No offense or expectation for you to include the below. I've forked your repo and added it there as well in case others find it.

Again, many thanks for your efforts.

🙏🏻, ✌🏻, ❤️ & 🤗,

--Shawn


A couple of notes before starting

Note 1: Please refer to the official Elgato Stream Deck documentation to create your own plugin if the below doesn't work for you as that will have the latest and greatest information.

Note 2: The process below was successfully completed on macOS Monterrey 12.0 Beta. The process is similar for Windows systems. Please refer to the Elgato documentation using the link in Note 1 above.

About This Mac

3 - Be sure you've completely QUIT the Stream Deck app before going through the steps below.


Steps

1 - Download ripnet's latest streamdeck-hubitat release

2 - Unzip/Extract the zip file in whatever directory/folder you downloaded the file (~/Downloads in the screenshot)

Extracted Folder in Downloads Directory

3 - Open a new Finder window (CMD+N) and use the Shift+CMD+G shortcut key to go to this folder:

`~/Library/Application Support/com.elgato.StreamDeck/Plugins/`

Stream Deck Plugins Directory

Note the full path to the Stream Deck Plugins Directory

Path to the Stream Deck Plugins Directory

5 - Back in the other Finder window (Downloads) drag and drop the extracted zip folder and all its contents to the Stream Deck Plugins Finder Window. Rename the folder to whatever you want. Be sure to include the .sdPlugin extension

GIF - Moving & Renaming the streamdeck-hubitat-main folder

If the embedded GIF doesn't show up here on GitHub, click on this link to view it

6 - Open the Stream Deck app and you should now see the Hubitat plugin at the bottom of the listed plugins in the right column

Hubitat Plugin is now Installed

7 - Continue on with ripnet's readme starting at the *Available Buttons section.

ripnet commented 3 years ago

Thanks! I'll get this pulled in shortly!

ripnet commented 2 years ago

Finally getting to this. Do you think this is necessary to do when you can simply click on the streamDeckPlugin file which will install it for you?

image

Let me know your thoughts.