Skip to content

Commit b59cc9c

Browse files
EnhancedJaxEnhancedJax
committed
2 parents 4b6babd + 419abd5 commit b59cc9c

File tree

3 files changed

+113
-88
lines changed

3 files changed

+113
-88
lines changed

‎.github/workflows/Dynamic-Readme.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: "📄 Dynamic ReadME"
2+
3+
env:
4+
VS_WORKFLOW_TYPE: "dynamic-readme"
5+
6+
on:
7+
workflow_dispatch:
8+
push:
9+
branches:
10+
- main
11+
paths:
12+
- README.md
13+
14+
jobs:
15+
update_readme:
16+
name: "Render & Update ReadME"
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: "📥 Fetching Repository Contents"
20+
uses: actions/checkout@main
21+
22+
- name: "💾 Github Repository Metadata"
23+
uses: varunsridharan/action-repository-meta@main
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
27+
- name: "💫 Update README.md"
28+
uses: "varunsridharan/action-dynamic-readme@main"
29+
with:
30+
GLOBAL_TEMPLATE_REPOSITORY: Jax-Core/ReadME-Template/Templates
31+
commit_message: ⏩ File Rebuilt by Github Actions - Dynamic ReadME
32+
files: |
33+
README.md
34+
env:
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 JaxCore
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 57 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,116 +1,85 @@
1-
1+
<!-- START Header.mustache -->
22
<br />
33
<div align="center">
44
<a href="https://github.com/Jax-Core/ModularClocks">
5-
<img src="https://i.imgur.com/716pCXy.png" alt="Logo" width="200" height="200">
5+
<img src="https://raw.githubusercontent.com/Jax-Core/ReadME-Template/main/Resources/Icons/ModularClocks.png" alt="Logo" width="180" height="180">
66
</a>
77

88
<h3 align="center">ModularClocks</h3>
9-
109
<p align="center">
11-
Animated & Modern Clock Styles.
12-
<br />
13-
<a href="https://www.deviantart.com/jaxoriginals/art/ModularClocks-v2-1-883898019"><strong>More Info »</strong></a>
10+
Gallery of animated &amp; modern clock widgets
1411
<br />
15-
<br />
16-
<a href="https://discord.gg/JmgehPSDD6">Report Bugs & Request Features </a>
12+
<a href="https://discord.gg/JmgehPSDD6">Help, Report Bugs & Request Features »</a>
1713
</p>
1814
</div>
15+
<!-- END Header.mustache -->
16+
<!-- START ShieldsBasic.mustache -->
17+
<p align="center">
18+
<img alt="Latest by date" src="https://img.shields.io/github/v/tag/Jax-Core/ModularClocks?label=Version&style=for-the-badge" />
19+
<img alt="Discord" src="https://img.shields.io/discord/880445067754610688?label=Discord%20server&style=for-the-badge" />
20+
<img alt="Github" src="https://img.shields.io/github/license/Jax-Core/ModularClocks?style=for-the-badge" />
21+
</p><!-- END ShieldsBasic.mustache -->
1922

20-
21-
<!-- TABLE OF CONTENTS -->
22-
<details>
23-
<summary>Table of Contents</summary>
24-
<ol>
25-
<li>
26-
<a href="#about">About</a>
27-
</li>
28-
<li>
29-
<a href="#Features">Features</a>
30-
</li>
31-
<li>
32-
<a href="#getting-started">Getting Started</a>
33-
<ul>
34-
<li><a href="#prerequisites">Prerequisites</a></li>
35-
<li><a href="#installation">Installation</a></li>
36-
<li><a href="#setting-up">Styles Setup</a>
37-
<ul>
38-
<li><a href="#installing-imagemagick">Installing ImageMagick</a></li>
39-
<li><a href="#choosing-presets">Choosing Presets</a>
40-
</ul>
41-
</li>
42-
</ul>
43-
</li>
44-
<li> <a href="#help-and-credits">Help & Credits</a></li>
45-
46-
</ol>
47-
</details>
48-
23+
<!-- START About.mustache -->
4924

5025
## About
5126

52-
![ModularClocks](https://images-wixmp-ed30a86b8c4ca887773594c2.wixmp.com/i/97bfd084-7ef0-496f-a835-3c41f482d38c/dem902r-659bc44d-7939-4cc8-9eb4-e638bf22c97d.png)
27+
![ModularClocks](https://raw.githubusercontent.com/Jax-Core/ReadME-Template/main/Resources/Splash/ModularClocks.png)
28+
<!-- END About.mustache -->
29+
**ModularClocks** is a gallery of hand-crafted clocks & weather widgets.
5330

54-
ModularClocks is a Rainmeter skin that includes a gallery of hand-crafted rainmeter clocks, a preview option, and an efficient settings menu.
55-
56-
57-
## Features
31+
<!-- START Features.mustache -->
5832

33+
## Features<!-- END Features.mustache -->
5934
* 5 Clock Presets
6035
* Animated Styles
6136
* Resizable Styles
37+
* Fully scalable
38+
39+
<!-- START GetStarted.mustache -->
6240

6341
## Getting Started
6442

6543
### Prerequisites
44+
- **Windows 10** or above
45+
> For older systems, **Powershell v5.1 or newer** is required. Upgrade powershell **[here](https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/install/installing-windows-powershell?view=powershell-7.2#upgrading-existing-windows-powershell)**!
6646
67-
- **Rainmeter v4.5 or newer.** Rainmeter can be installed by downloading the `.exe` file [from Rainmeter's official website.](https://www.rainmeter.net/)
68-
- **JaxCore v40005 or newer.** JaxCore can be installed by downloading the `.rmskin` file from [JaxCore's official website.](https://jax-core.github.io/)
69-
70-
### Installation
71-
72-
Assuming you successfully downloaded and installed Rainmeter as well as JaxCore, you can now proceed to install ModularClocks by following the steps below.
47+
### Installation
48+
Run the following command in Powershell to download the latest version of JaxCore.
7349

74-
1. Download and run the `.rmskin` file for **ModularClocks** from the official [JaxCore site](https://jax-core.github.io/) to install **ModularClocks**.
75-
2. Leave the installation settings at their defaults and click Install.
76-
3. When the installation is finished, a startup pop-up should appear. Follow through the pop-up to finish installing **ModularClocks**.
50+
(To launch Powershell as an Admin: `Win + R` -> `powershell` -> Press `CTRL + SHIFT + ENTER` on your keyboard. Powershell can also be launched via Windows Search.)
7751

78-
* Note: If you find that the JaxCore option is red on the startup pop-up, please press the red button and Core will be installed automatically. Perchance this fails, you can manually install Core by downloading the `.rmskin` file from [JaxCore's official website.](https://jax-core.github.io/)
52+
```
53+
Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/Jax-Core/JaxCore/master/CoreInstaller.ps1" | Invoke-Expression
54+
```
7955

80-
### Setting Up
56+
> Alternatively you can download it from the [website](https://jax-core.github.io/)
8157
82-
To use the custom clock styles, you must first install and configure **[ImageMagick](https://github.com/khanhas/MagickMeter).** If you already have **ImageMagick** setup, you can skip to choosing the presets; if not, follow the instructions below to setup **ImageMagick**.
83-
84-
85-
#### Installing ImageMagick:
86-
87-
1. Open **[this link](https://www.imagemagick.org/script/download.php#windows)**. This link will take you to another site where you must locate and download the appropriate installer.
88-
2. Find a suitable release under **Windows Binary Release** that corresponds to your requirements and download it. The `ImageMagick-7.1.0-19-Q16-HDRI-x64-dll.exe` executable will be used to install for this guide.
89-
3. After the download is complete, run the installer, which in this case is `ImageMagick-7.1.0-19-Q16-HDRI-x64-dll.exe`.
90-
4. Leave the installation settings at their defaults and follow through the installation. You can tinker around with the settings **ONLY** if you know what they do.
91-
5. Open **[this link](https://github.com/khanhas/MagickMeter/releases)** and dowload the latest release of the **MagickMeter** skin. The `magickmeter_0.7.3.rmskin` Rainmeter skin file will be used to install for this guide.
92-
6. Leave the installation settings at their defaults and click Install.
93-
7. Restart Rainmeter and your plugin will be activated.
94-
95-
And that is how you setup **ImageMagick**. You can now proceed to configure the Clock Presets.
96-
97-
* **Note:** An alternate approach for **Step 5** and **Step 6** is:
98-
- Download the [plugin DLLs](https://github.com/khanhas/MagickMeter/releases)
99-
- Copy the version that corresponds to your system from the zip file (x86 or x64)
100-
- Open Run(`Win + R`), type `%appdata%\Rainmeter\Plugins\` and press **OK**.
101-
- Manually paste DLL you copied in the second step.
102-
- Finally, restart Rainmeter and your plugin will be activated.
103-
104-
#### Choosing Presets:
105-
Follow the steps outlined below to setup custom clock presets:
106-
107-
1. Open Core and head over to the **Desktop** section.
108-
2. Select **ModularClocks** from the list and proceed to the **Appearance** tab.
109-
3. Under **Clock Style** choose a preset that tickles your fancy.
110-
4. The clock style will be changed if you refresh **ModularClocks** by deactivating and activating the toggle on the bottom left.
111-
112-
* **Note:** The **Render** and **Appearance** tabs allow you to further customize each preset as required.
113-
114-
## Help and Credits
115-
- MagickMeter and ImageMagick plugins by [khanhas](https://github.com/khanhas)
116-
- Join the [Core Community Discord Server](https://discord.gg/JmgehPSDD6) for more help.
58+
After you've proceeded through the welcome screen, select `ModularClocks` (might have to scroll down) and click `Install`. It will appear in the library page after that.
59+
<br />
60+
<br /><!-- END GetStarted.mustache -->
61+
<!-- START Setup.mustache -->
62+
63+
### Configuration
64+
Use the JaxCore menu to configure ModularClocks.
65+
For more information, visit [JaxCore's documentation](https://jaxcore.gitbook.io/core/)
66+
<br>
67+
<br><!-- END Setup.mustache -->
68+
<!-- START Footer.mustache -->
69+
70+
## Need assistance?
71+
* Join the [CoreCommunity Discord Server](https://discord.gg/JmgehPSDD6) for help
72+
* or [Create an issue](https://github.com/Jax-Core/ModularClocks)
73+
74+
## Say Hi!
75+
* Follow me on 👨‍💻 [Github](https://github.com/EnhancedJax) and stay updated on new things that I make
76+
* You can also watch me on 🐦 [DeviantArt](https://www.deviantart.com/jaxoriginals) instead
77+
* Message me on 🗨️ [Discord](https://discord.gg/JmgehPSDD6)
78+
79+
---
80+
81+
<p align="center">
82+
<i>Made with ❤️ by Jax</i>
83+
<br/><br/>
84+
<img src="https://raw.githubusercontent.com/Jax-Core/ReadME-Template/main/Resources/Assets/Logo.png" width="32" height="32"/>
85+
</p><!-- END Footer.mustache -->

0 commit comments

Comments
 (0)