Skip to content

Commit a2d2eb8

Browse files
EnhancedJaxEnhancedJax
authored
Merge pull request #3 from vo1x/volx's-additions
Updated README
2 parents 2dfeffc + 0935bb8 commit a2d2eb8

File tree

1 file changed

+106
-32
lines changed

1 file changed

+106
-32
lines changed

‎README.md‎

Lines changed: 106 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,111 @@
1-
<h1 align="center">
2-
Modular Clocks
3-
</h1>
41

5-
<h4 align="center">Download Now!</h4>
2+
<br />
3+
<div align="center">
4+
<a href="https://github.com/Jax-Core/ModularClocks">
5+
<img src="https://i.imgur.com/716pCXy.png" alt="Logo" width="200" height="200">
6+
</a>
67

7-
A gallery of hand-crafted rainmeter clocks with built in preview and settings menu. Download rainmeter [here](https://www.rainmeter.net/).
8+
<h3 align="center">ModularClocks</h3>
9+
10+
<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>
14+
<br />
15+
<br />
16+
<a href="https://discord.gg/JmgehPSDD6">Report Bugs & Request Features </a>
17+
</p>
18+
</div>
19+
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></li>
37+
</ul>
38+
</li>
39+
<li> <a href="#help-and-credits">Help & Credits</a></li>
40+
41+
</ol>
42+
</details>
43+
44+
45+
## About
46+
47+
![ModularClocks](https://images-wixmp-ed30a86b8c4ca887773594c2.wixmp.com/i/97bfd084-7ef0-496f-a835-3c41f482d38c/dem902r-659bc44d-7939-4cc8-9eb4-e638bf22c97d.png)
48+
49+
ModularClocks is a Rainmeter skin that includes a gallery of hand-crafted rainmeter clocks, a preview option, and an efficient settings menu.
850

9-
## Styles Previews
10-
<img src="https://github.com/EnhancedJax/ModularClocks/blob/main/%40Resources/Images/Preview/Fullscale/Measure.png"/>
11-
<img src="https://github.com/EnhancedJax/ModularClocks/blob/main/%40Resources/Images/Preview/Fullscale/Text.png"/>
12-
<img src="https://github.com/EnhancedJax/ModularClocks/blob/main/%40Resources/Images/Preview/Fullscale/Center.png"/>
13-
<img src="https://github.com/EnhancedJax/ModularClocks/blob/main/%40Resources/Images/Preview/Fullscale/Graph.png"/>
14-
<img src="https://github.com/EnhancedJax/ModularClocks/blob/main/%40Resources/Images/Preview/Fullscale/Smart.png"/>
1551

1652
## Features
17-
- Blur / shadow / color fill
18-
- Auto-centering
19-
- Animated clocks
20-
21-
# Installation
22-
### Requirements
23-
Rainmeter 4.4 beta or newer: [Download here](https://www.rainmeter.net/)
24-
25-
### Installation Instructions
26-
1. Install rainmeter
27-
1. Download the latest release
28-
1. Open the .rmskin package
29-
1. Leave the installation settings default, and press install
30-
31-
**You'll also have to install ImageMagick for the skin to function. Follow [THIS](https://github.com/khanhas/MagickMeter#how-to-install) guide.**
32-
33-
## Contact me
34-
via Discord: **Jax#1090**
35-
36-
## Special thanks to
37-
[@khanhas](https://github.com/khanhas) for the MagickMeter plugin
53+
54+
* 5 Clock Presets
55+
* Animated Styles
56+
* Resizable Styles
57+
58+
## Getting Started
59+
60+
### Prerequisites
61+
62+
- **Rainmeter v4.5 or newer.** Rainmeter can be installed by downloading the `.exe` file [from Rainmeter's official website.](https://www.rainmeter.net/)
63+
- **JaxCore v40005 or newer.** JaxCore can be installed by downloading the `.rmskin` file from [JaxCore's official website.](https://jax-core.github.io/)
64+
65+
### Installation
66+
67+
Assuming you successfully downloaded and installed Rainmeter as well as JaxCore, you can now proceed to install ModularClocks by following the steps below.
68+
69+
1. Download and run the `.rmskin` file for **ModularClocks** from the official [JaxCore site](https://jax-core.github.io/) to install **ModularClocks**.
70+
2. Leave the installation settings at their defaults and click Install.
71+
3. When the installation is finished, a startup pop-up should appear. Follow through the pop-up to finish installing **ModularClocks**.
72+
73+
* 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/)
74+
75+
### Setting Up
76+
77+
To use the custom clock styles, you must first install and configure **[ImageMagick](https://github.com/khanhas/MagickMeter).** Follow the instructions below to setup **ImageMagick**.
78+
79+
80+
#### Installing ImageMagick:
81+
82+
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.
83+
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.
84+
3. After the download is complete, run the installer, which in this case is `ImageMagick-7.1.0-19-Q16-HDRI-x64-dll.exe`.
85+
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.
86+
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.
87+
6. Leave the installation settings at their defaults and click Install.
88+
7. Restart Rainmeter and your plugin will be activated.
89+
90+
And that is how you setup **ImageMagick**. You can now proceed to configure the Clock Presets.
91+
92+
* **Note:** An alternate approach for **Step 5** and **Step 6** is:
93+
- Download the [plugin DLLs](https://github.com/khanhas/MagickMeter/releases)
94+
- Copy the version that corresponds to your system from the zip file (x86 or x64)
95+
- Open Run(`Win + R`), type `%appdata%\Rainmeter\Plugins\` and press **OK**.
96+
- Manually paste DLL you copied in the second step.
97+
- Finally, restart Rainmeter and your plugin will be activated.
98+
99+
#### Choosing Presets:
100+
Follow the steps outlined below to setup custom clock presets:
101+
102+
1. Open Core and head over to the **Desktop** section.
103+
2. Select **ModularClocks** from the list and proceed to the **Appearance** tab.
104+
3. Under **Clock Style** choose a preset that tickles your fancy.
105+
4. The clock style will be changed if you refresh **ModularClocks** by deactivating and activating the toggle on the bottom left.
106+
107+
* **Note:** The **Render** and **Appearance** tabs allow you to further customize each preset as required.
108+
109+
## Help and Credits
110+
- MagickMeter and ImageMagick plugins by [khanhas](https://github.com/khanhas)
111+
- Join the [Core Community Discord Server](https://discord.gg/JmgehPSDD6) for more help.

0 commit comments

Comments
 (0)