xstefen/winutil
1
0
Fork 0
mirror of https://github.com/ChrisTitusTech/winutil.git synced 2024-11-14 22:55:52 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix some bullet points in 'contribute.md' file as well as some improvments to the graph (#2472)

Browse Source 
* Fix some bullet points in 'contribute.md' file as well as some improvments to the graph

* Make the badges in 'index.md' file be in one paragraph
This commit is contained in:
Mr.k 2024-08-06 20:44:51 +03:00 committed by GitHub
parent 2b01fb739f
commit a77ef020fe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/contribute.md
View File

@ -46,18 +46,20 @@
### Overview ### Overview
``` mermaid ``` mermaid
graph LR %%{init: {"flowchart": {"curve": "cardinal"}} }%%
graph TD
  A[Fork Project] --> B[Clone Repository];   A[Fork Project] --> B[Clone Repository];
  B --> C[Create New Branch];   B --> C[Create New Branch];
  C --> D[Make Changes];   C --> D[Make Changes];
  D --> G[Test Changes];   D --> G[Test Changes];
  G --> H{Tests Passed?};   G --> H{Tests Passed?};
  H -->|Yes| E[Commit Changes];   H -->|Yes| E[Commit Changes];
  E --> F[Push Branch];
  H -->|No| J[Fix Issues];   H -->|No| J[Fix Issues];
  J --> G;
  E --> F[Push Branch];
  F --> K[Create Pull Request];   F --> K[Create Pull Request];
  K --> L[Fill out PR template];   K --> L[Fill out PR template];
  J --> G; classDef default stroke:#333,stroke-width:4px,font-size:12pt;
``` ```
!!! info !!! info
@ -65,8 +67,10 @@ graph LR
### Fork the Repo ### Fork the Repo
* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list. * Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list.
![Fork Image](assets/Fork-Button-Dark.png#only-dark) ![Fork Image](assets/Fork-Button-Dark.png#only-dark)
![FOrk Image](assets/Fork-Button-Light.png#only-light)
![Fork Image](assets/Fork-Button-Light.png#only-light)
### Clone the Fork ### Clone the Fork
!!! tip !!! tip
@ -89,15 +93,22 @@ graph LR
* `cd {path to the folder with the compile.ps1}` * `cd {path to the folder with the compile.ps1}`
* Run the following command to compile and run WinUtil: * Run the following command to compile and run WinUtil:
* `.\Compile.ps1 -run` * `.\Compile.ps1 -run`
* ![Compile](assets/Compile.png)
![Compile](assets/Compile.png)
* After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below. * After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.
### Committing the changes ### Committing the changes
* Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following: * Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
- ![Push Commit Image](assets/Discard-GHD.png)
![Push Commit Image](assets/Discard-GHD.png)
* Now, commit your changes once you are happy with the result. * Now, commit your changes once you are happy with the result.
![Commit Image](assets/Commit-GHD.png) ![Commit Image](assets/Commit-GHD.png)
* Push the changes to upload them to your fork on github.com. * Push the changes to upload them to your fork on github.com.
![Push Commit Image](assets/Push-Commit.png) ![Push Commit Image](assets/Push-Commit.png)
### Making a PR ### Making a PR

1
docs/index.md
View File

@ -2,7 +2,6 @@
[![Version](https://img.shields.io/github/v/release/ChrisTitusTech/winutil?color=%230567ff&label=Latest%20Release&style=for-the-badge)](https://github.com/ChrisTitusTech/winutil/releases/latest) [![Version](https://img.shields.io/github/v/release/ChrisTitusTech/winutil?color=%230567ff&label=Latest%20Release&style=for-the-badge)](https://github.com/ChrisTitusTech/winutil/releases/latest)
![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/ChrisTitusTech/winutil/winutil.ps1?label=Total%20Downloads&style=for-the-badge) ![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/ChrisTitusTech/winutil/winutil.ps1?label=Total%20Downloads&style=for-the-badge)
[![Discord Community Server](https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ)](https://discord.gg/RUbZUZyByQ) [![Discord Community Server](https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ)](https://discord.gg/RUbZUZyByQ)
Welcome to the official documentation for WinUtil, your go-to utility for optimizing and managing your Windows environment. Whether you’re an IT professional, power user, or regular user, WinUtil provides a comprehensive set of tools to enhance your Windows experience. Welcome to the official documentation for WinUtil, your go-to utility for optimizing and managing your Windows environment. Whether you’re an IT professional, power user, or regular user, WinUtil provides a comprehensive set of tools to enhance your Windows experience.