Skip to content

Commit 3ed7df3

Browse files
EnhancedJaxEnhancedJax
committed
2 parents bb904da + a1883b4 commit 3ed7df3

2 files changed

Lines changed: 83 additions & 145 deletions

File tree

‎.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 }}

‎README.md‎

Lines changed: 48 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -1,188 +1,91 @@
1-
<div id="top"></div>
2-
1+
<!-- START Header.mustache -->
32
<br />
43
<div align="center">
54
<a href="https://github.com/Jax-Core/ValliStart">
6-
<img src="https://cdn.discordapp.com/attachments/875630623853793283/977856719055114250/ValliStart3.png" alt="Logo" width="200" height="200">
5+
<img src="https://raw.githubusercontent.com/Jax-Core/ReadME-Template/main/Resources/Icons/ValliStart.png" alt="Logo" width="180" height="180">
76
</a>
8-
<h3 align="center">ValliStart</h3>
7+
8+
<h3 align="center">ValliStart</h3>
99
<p align="center">
10-
A custom start menu to replace the default one.
11-
<br />
12-
<a href="https://www.deviantart.com/jaxoriginals/art/ ValliStart-Start-menu-replacement-893506095"><strong>More Info »</strong>
13-
</a>
14-
<br />
10+
A start menu to replace the un-customizable one that you have right now.
1511
<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>
1915

16+
<!-- END Header.mustache -->
17+
<!-- START ShieldsFull.mustache -->
2018
<p align="center">
2119
<img alt="Latest by date" src="https://img.shields.io/github/v/tag/Jax-Core/ValliStart?label=Version&style=for-the-badge" />
2220
<img alt="Releases" src="https://img.shields.io/github/downloads/Jax-Core/ValliStart/total?style=for-the-badge" />
2321
<img alt="Release date" src="https://img.shields.io/github/release-date/Jax-Core/ValliStart?label=Last%20Update&style=for-the-badge" />
2422
<img alt="Discord" src="https://img.shields.io/discord/880445067754610688?label=Discord%20server&style=for-the-badge" />
2523
<img alt="Github" src="https://img.shields.io/github/license/Jax-Core/ValliStart?style=for-the-badge" />
26-
27-
</p>
28-
29-
<!-- TABLE OF CONTENTS -->
30-
<details>
31-
<summary>Table of Contents</summary>
32-
<ol>
33-
<li>
34-
<a href="#about">About</a>
35-
</li>
36-
<li>
37-
<a href="#Features">Features</a>
38-
</li>
39-
<li>
40-
<a href="#getting-started">Getting Started</a>
41-
<ul>
42-
<li><a href="#prerequisites">Prerequisites</a></li>
43-
<li><a href="#installation">Installation</a></li>
44-
<li> <a href="#customization">Customization</a></li>
45-
</ul>
46-
</li>
47-
<li>
48-
<a href="#modules-setup">Modules Setup</a>
49-
<ul>
50-
<li><a href="#pinned-shortcuts">Pinned Shortcuts</a></li>
51-
<li><a href="#weather">Weather</a></li>
52-
<li><a href="#media-controls">Media Controls</a>
53-
<ul>
54-
<li><a href="#for-spotify">Spotify</a></li>
55-
<li><a href="#for-web-players">Web Players</a></li>
56-
</ul>
57-
</li>
58-
</ul>
59-
</li>
60-
<li> <a href="#help-and-credits">Help & Credits</a></li>
61-
</ol>
62-
</details>
63-
64-
<!-- ABOUT THE PROJECT -->
24+
</p><!-- END ShieldsFull.mustache -->
25+
26+
<!-- START About.mustache -->
27+
6528
## About
6629

67-
![ValliStart3](https://user-images.githubusercontent.com/80020581/169686772-4ffa8032-c98f-4af7-9805-4f6bcfd25d32.png)
30+
![ValliStart](https://raw.githubusercontent.com/Jax-Core/ReadME-Template/main/Resources/Splash/ValliStart.png)
6831

69-
ValliStart is a start menu replacement for Windows, with full customizability, interchangeable modules and more.
32+
<!-- END About.mustache -->
33+
**ValliStart** is a start menu replacement for Windows, with full customizability, interchangeable modules and more.
7034

71-
## Features
35+
<!-- START Features.mustache -->
7236

37+
## Features<!-- END Features.mustache -->
7338
* Flawless Animations
7439
* Full-fledged Control Center
7540
* Custom Pinned Shortcuts
7641
* Intergrated Media Controls
7742
* Customizable Hotkeys
7843
* Additional Modules like Weather Status
7944

80-
<p align="right">
81-
<b><a href="#top">↥ back to top</a></b>
82-
</p>
45+
<!-- START GetStarted.mustache -->
8346

84-
<!-- INSTALLATION AND SETUP -->
8547
## Getting Started
8648

8749
### Prerequisites
8850
- **Windows 10** or above
89-
- 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)**!
51+
> 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)**!
9052
9153
### Installation
92-
**By Powershell CLI:**
93-
Run the following command in Powershell (`win + r` -> `powershell.exe` / search)
94-
```
95-
$installSkin="ValliStart";Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/Jax-Core/JaxCore/master/CoreInstaller.ps1" | Invoke-Expression
96-
```
97-
**By legacy [Rainmeter](https://www.rainmeter.net/) .rmskin installer:**
98-
Download and run the `.rmskin` file from the latest release **[here](https://github.com/Jax-Core/ValliStart/releases/latest)**.
99-
> 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/)
100-
<br />
101-
<br />
102-
103-
## Customization
104-
105-
ValliStart includes 6 color scheme presets. You enable them by just selecting them within the **Color Scheme** tab.
106-
Furthermore, ValliStart also comes with 4 layout presets. You can enable them by just selecting them within the **Layout** tab:
107-
108-
![image](https://user-images.githubusercontent.com/80020581/156275153-104e47da-ef14-4b63-8809-a5058d15f417.png)
109-
110-
## Activation
111-
ValliStart can be activated in multiple ways:
112-
#### Replacing the native windows button and key
113-
You can launch ValliStart just like the start menu with the `Win` Key. Additionally, you can replace the windows button by:
114-
- Creating a pseudo start button with core
115-
1. Navigate to `JaxCore -> ValliStart -> General -> Setting: Customize how to activate ValliStart` and turn on override start button.
116-
2. Select a start orb name. The default is `Win11`. You can choose another one / add your own one in the orbs directory, and entering another start orb name.
117-
3. Press the `Create` button above
118-
4. Core should popup the explorer with shortcut `ValliStart.lnk` inside
119-
5. Drag the shortcut to the taskbar
120-
6. Now you have a pseudo start button on the taskbar!
121-
7. If you want to remove the stock start button: You can use [StartKiller](http://www.startkiller.com/) for Win10. There are no known ways of doing so on Windows 11.
122-
123-
- Using ValliStart's winblock function to create an overlay which overlaps the start button on your taskbar
124-
1. Navigate to `JaxCore -> ValliStart -> General -> Setting: Customize how to activate ValliStart` and turn on override start button.
125-
2. Toggle `Setting: Display WinBlock element (legacy)` on
126-
3. Switch `Setting: Win block behavior` to edit
127-
4. Drag the winblocker to desired location
128-
5. Switch `Setting: Win block behavior` to functional
54+
Run the following command in Powershell to download the latest version of JaxCore.
12955

130-
#### Using a separate hotkey
131-
You can also launch ValliStart with the hotkey of your choice. This does not support overriding the displayed window button on your taskbar.
132-
1. Navigate to `JaxCore -> ValliStart -> General -> Setting: How should ValliStart behave?` and switch the option to `Separate module`
133-
2. Change `Setting: Activation Hotkey`to your desired hotkey
56+
(To launch Powershell as an Admin: `Win + R` -> `powershell` -> Press `CTRL + SHIFT + ENTER` on your keyboard. Powershell can also be launched via Windows Search.)
13457

135-
<p align="right">
136-
<b><a href="#top">↥ back to top</a></b>
137-
</p>
138-
139-
<!-- MODULES SETUP -->
140-
# Modules Setup
141-
142-
Now that you've installed and setup ValliStart, let's begin setting up some modules it comes with!
143-
144-
## Pinned Shortcuts
145-
146-
### Choosing a module preset
147-
148-
If your ValliStart layout preset does not have the pinned shortcuts module enabled by default, follow the steps outlined below to enable it. However, if it is already enabled/selected, you can skip to configuring it.
149-
150-
1. Open Core and head over to the **Modules** section.
151-
2. Select **ValliStart** from the list and proceed to the **Modules** tab.
152-
3. Scroll all way to the bottom, find the module labelled **None** and click `Change`. Alternatively, you can also replace any other pre-existing module with the shortcut module.
153-
4. Go to the **Shortcut Modules** tab and select a preset you like. You can choose from three presets; **WinRow11**, **DoubleRow**, and **SingleRow**.
154-
> <img src ="https://imgur.com/JgHZTni.png" alt = "ref" width="378" height ="80">
155-
156-
### Configuring the preset
157-
158-
1. Open Core and head over to the **Modules** section.
159-
2. Select **ValliStart** from the list and proceed to the **Modules** tab.
160-
3. Open the settings for your currently enabled shortcuts module.
161-
4. Click on one of the pre-existing shortcut's name.
162-
5. Select the shortcut for the application to be pinned.
163-
164-
That's all there is to it. Your shortcuts will now be visible in the pinned applications section.
165-
166-
## Weather
58+
```
59+
Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/Jax-Core/JaxCore/master/CoreInstaller.ps1" | Invoke-Expression
60+
```
16761

168-
1. Open Core and head over to the **Modules** section.
169-
2. Select **ValliStart** from the list and proceed to the **Modules** tab.
170-
3. Open the settings for the **Weather** module.
171-
4. Click the green redirect button next to the `Configure weather settings in core's global settings` text.
172-
> <img src ="https://imgur.com/WDatjK5.png" alt = "ref" width="755" height ="81">
62+
> Alternatively you can download it from the [website](https://jax-core.github.io/)
17363
174-
5. Once the **Global Variables** configuration window opens, change the weather location to the location you want the weather status of.
175-
> <img src ="https://imgur.com/ycI4Qp4.png" alt = "ref" width="867" height ="55">
176-
6. Refresh ValliStart by deactivating and activating again using the toggle on the bottom left.
64+
After you've proceeded through the welcome screen, select `ValliStart` (might have to scroll down) and click `Install`. It will appear in the library page after that.
65+
<br />
66+
<br /><!-- END GetStarted.mustache -->
67+
<!-- START Setup.mustache -->
17768

178-
> **Note:** You can also alter other options like the temperature unit, the language the weather is shown in, and the time format when configuring the weather location on **Step 5**. Also, **if you're not sure what the API key is for, don't change or edit it.**
69+
### Configuration
70+
Use the JaxCore menu to configure ValliStart.
71+
For more information, visit [JaxCore's documentation](https://jaxcore.gitbook.io/core/)
72+
<br>
73+
<br><!-- END Setup.mustache -->
74+
<!-- START Footer.mustache -->
17975

180-
# Help and Credits
76+
## Need assistance?
77+
* Join the [CoreCommunity Discord Server](https://discord.gg/JmgehPSDD6) for help
78+
* or [Create an issue](https://github.com/Jax-Core/ValliStart)
18179

182-
* Spicetify installation guide by [khanhas](https://github.com/khanhas).
80+
## Say Hi!
81+
* Follow me on 👨‍💻 [Github](https://github.com/EnhancedJax) and stay updated on new things that I make
82+
* You can also watch me on 🐦 [DeviantArt](https://www.deviantart.com/jaxoriginals) instead
83+
* Message me on 🗨️ [Discord](https://discord.gg/JmgehPSDD6)
18384

184-
* Join the [Core Community Discord Server](https://discord.gg/JmgehPSDD6) for more help.
85+
---
18586

186-
<p align="right">
187-
<b><a href="#top">↥ back to top</a></b>
188-
</p>
87+
<p align="center">
88+
<i>Made with ❤️ by Jax</i>
89+
<br/><br/>
90+
<img src="https://raw.githubusercontent.com/Jax-Core/ReadME-Template/main/Resources/Assets/Logo.png" width="32" height="32"/>
91+
</p><!-- END Footer.mustache -->

0 commit comments

Comments
 (0)