Skip to content

Commit 198ebaa

Browse files
committed
chore(deps): update dependabot allowed packages and polish docs
- Refined allowed dependencies list in dependabot.yml - Updated and polished wiki/documentation content
1 parent fc64012 commit 198ebaa

File tree

5 files changed

+371
-370
lines changed

5 files changed

+371
-370
lines changed

.github/dependabot.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ updates:
1313
- dependency-name: "pyqt6"
1414
- dependency-name: "pillow"
1515
- dependency-name: "pycaw"
16-
- dependency-name: "cx-Freeze"
16+
- dependency-name: "cx-freeze"
17+
- dependency-name: "psutil"
18+
- dependency-name: "screen-brightness-control"
19+
- dependency-name: "holidays"
20+
- dependency-name: "icoextract"
1721
commit-message:
1822
prefix: "chore"
1923
include: "scope"

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
***
1515

1616
<h3 align="center">
17-
<a href="https://github.com/amnweb/yasb/wiki">Wiki</a>・<a href="https://github.com/amnweb/yasb-themes">Share Your Theme</a>・<a href="https://github.com/amnweb/yasb/discussions">Discussions</a>・<a href="https://github.com/amnweb/yasb/issues">Report a bug</a>
17+
<a href="https://github.com/amnweb/yasb/wiki/Installation">Installation</a>・<a href="https://github.com/amnweb/yasb/wiki">Docs</a>・<a href="https://github.com/amnweb/yasb-themes">Share Your Theme</a>・<a href="https://github.com/amnweb/yasb/discussions">Discussions</a>・<a href="https://github.com/amnweb/yasb/issues">Report a bug</a>
1818
</h3>
1919

2020
***

docs/Installation.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,25 @@
22
- Nerd Fonts. Install [Nerd Fonts](https://www.nerdfonts.com/font-downloads) ([JetBrainsMono](https://github.com/ryanoasis/nerd-fonts/releases/latest/download/JetBrainsMono.zip) recommended)
33
- Windows 10 & 11
44

5-
### Manual Installation
6-
1. Download the latest installer from the [GitHub releases page](https://github.com/amnweb/yasb/releases/latest).
7-
2. Run the installer and follow the on-screen instructions to complete the installation.
5+
### Manual Installation (stable release)
6+
1. Go to the [releases page](htpps://github.com/amnweb/yasb/releases).
7+
2. Choice the architecture that matches your system (x64 or ARM64).
8+
3. Download the `yasb-{version}-{architecture}.msi` installer.
9+
4. Run the installer and follow the on-screen instructions.
810

11+
12+
### Manual Installation (latest development build)
13+
1. Go to the [pre release](https://github.com/amnweb/yasb/releases/tag/dev)
14+
2. Choice the architecture that matches your system (x64 or ARM64).
15+
3. Download the `yasb-dev-{architecture}.msi` installer.
16+
4. Run the installer and follow the on-screen instructions.
17+
18+
19+
20+
### Using Package Managers (only stable releases)
921
***
1022

23+
1124
### Winget
1225
Install YASB using [winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/):
1326
```powershell
@@ -34,10 +47,11 @@ choco install yasb
3447
***
3548

3649
### Using Python
37-
- Install Python >= 3.12
50+
- Install Python >= 3.14
3851
- Install the application and its dependencies:
3952
- `pip install .` (for regular installation)
4053
- `pip install -e .[dev]` (for development installation)
54+
- `pip install -e .[dev,packaging]` (for packaging development installation)
4155
- Create the directory `C:/Users/{username}/.config/yasb/` and copy [styles.css](https://github.com/amnweb/yasb/blob/main/src/styles.css) and [config.yaml](https://github.com/amnweb/yasb/blob/main/src/config.yaml) into folder. If you don't have the `.config/yasb/` directory, on first run the application will create it for you. To use a custom directory, set the `YASB_CONFIG_HOME` environment variable.
4256
- Configure [styles.css](https://github.com/amnweb/yasb/blob/main/src/styles.css) and [config.yaml](https://github.com/amnweb/yasb/blob/main/src/config.yaml) to your liking.
4357
- Start the application:
@@ -47,7 +61,7 @@ choco install yasb
4761
### Build from source
4862
- Clone the repository: `git clone https://github.com/amnweb/yasb`
4963
- Navigate to the project directory: `cd yasb`
50-
- Install the required dependencies: `pip install -e .[dev]`
64+
- Install the required dependencies: `pip install -e .[packaging]`
5165
- Navigate to the `src` directory: `cd src`
5266
- Build the installer using following command:
5367
```powershell

0 commit comments

Comments
 (0)