GitHub can be an awesome tool to use with your Rainmeter projects. Among many other things you can use it to keep track of all your changes, create variation of the same skin, easily collaborate with others, and it can serve as a backup in case you loose your local Rainmeter files.
However, if you are like me and have never used GitHub before in your life it can be a bit of a headache trying to figure out how to use it. The goal of this guide is to help others learn the basics of using GitHub with their skins.
NOTE Bear in mind that this is literally my first time writing a guide and I am still refining it.
Setting up GitHub (as of 03/18/16)
In order to use GitHub with a Rainmeter skin, we need to create a new repository. What's a repository you ask? It is "a central location in which data is stored and managed."
- Windows 7 or newer (technically speaking you could also use GitHub to edit Rainmeter skins on a Mac )
- A decent internet connection
- A GitHub account (Create account here)
- GitHub Desktop installed
There are three basic ways of setting up a repository for a Rainmeter skin in GitHub Desktop.
- Option 1 Creating a new local repository
- USE FOR Locally installed skins (meaning, skins located in Rainmeter's Skins folder). You can also use this if you want to create a new skin folder for a new project.
- USE FOR Downloading one of your Rainmeter skin repositories off of GitHub.com.
- USE FOR Adding a local Rainmeter skin repository that is not currently listed in GitHub Desktop (such as a repository you accidentally removed from GitHub Desktop)
Option 1 - Creating a new local repository
Open the spoiler to view the guide
NOTE You now have a created a repository on your computer, but it still isn't uploaded to GitHub.com yet. You can stop at this point if you want to only use GitHub locally with your skin. However, if you want to be able to upload and backup your work to GitHub.com you need to read on (you can easily complete this process later if you prefer).
Uploading a local repository to GitHub.com
You now should see the skin listed in your profile on GitHub.com. In GitHub Desktop the Publish button should now be replaced with the Sync button. You can use this to upload new commits to GitHub.com.
Using GitHub (Under Construction)
Commits to what?!
At first many of the features and terminology of GitHub seemed strange and foreign to me. In this section I will explain how to use some key features of GitHub with Rainmeter skins.
Any questions, comments, feedback, and suggestions are welcome!
Hope you find this helpful!