Skip to content

Commit 169977e

Browse files
authored
2.7 (#21)
Updated version number and column width, removed terminal resizing functionality, and adjusted related code. * Revise contributing guidelines for clarity and structure * Added caches and created cc_caches Updated the system software list to include Shell History and Package Managers. * Refactor installation instructions in README * Moved most functions to seperate file & code cleanup * Update issue templates (#22) * Enhance README with updated badges Go Report Card has been sunset :( * Changed Logo
1 parent 90e2156 commit 169977e

14 files changed

Lines changed: 456 additions & 420 deletions

File tree

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report
4+
title: ''
5+
labels: bug
6+
assignees: Knuspii
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. Linux Ubuntu]
28+
- Terminal:
29+
30+
31+
**Additional context**
32+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: Knuspii
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# 🚀 How Can you Contribute?
22
## 1. Adding New Programs/Caches
33
The most common way to contribute is by adding support for more applications.
4+
* Open the cc_caches.go file.
45
* Locate the getPrograms() function
56
* Add a new Program struct to the slice.
67
* **Important:** Ensure you provide paths for both Windows and Linux where possible.
78
* Use filepath.Join and environment variables (like localAppData) and maintain cross-platform compatibility.
89

9-
## 2. Improving the UI/TUI
10+
## 2. Improving the TUI
1011
I aim for a "Crunchy" retro terminal feel. Improvements to the menu navigation, spinner, or banner are welcome, provided they don't add external dependencies.
1112

1213
## 3. Bug Reports & Feature Requests
@@ -22,7 +23,7 @@ If you find a bug or have an idea:
2223
## 📥 Pull Request Process
2324
* Fork the repository and create your branch from main.
2425
* Test your changes! Run a dry-run (-d) to ensure paths are detected correctly.
25-
* Commit with descriptive messages (e.g., "Add Spotify cache support").
26+
* Commit with descriptive messages (e.g., "Add: Spotify cache support").
2627
* Open a PR and describe what your changes do and why they are necessary.
2728

2829
## ⚖️ License

README.md

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
<p align="center">
2-
<img src="https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg" />
3-
<a href="https://goreportcard.com/report/github.com/knuspii/crunchycleaner/v2"><img src="https://goreportcard.com/badge/github.com/knuspii/crunchycleaner/v2" alt="Go Report Card" /></a>
4-
<a href="https://github.com/knuspii/crunchycleaner/actions/workflows/go.yml"><img src="https://github.com/knuspii/crunchycleaner/actions/workflows/go.yml/badge.svg" alt="Build" /></a>
5-
<a href="https://github.com/knuspii/crunchycleaner/stargazers"><img src="https://img.shields.io/github/stars/knuspii/crunchycleaner?style=social" alt="GitHub Stars" /></a>
6-
<br>
7-
<img src="https://img.shields.io/github/downloads/knuspii/crunchycleaner/total?color=green?" />
8-
<img src="https://img.shields.io/badge/Platform-Windows%20%7C%20Linux-blue?logo=linux&logoColor=white" alt="Platform" />
2+
<a href="https://github.com/knuspii/crunchycleaner/actions">
3+
<img src="https://img.shields.io/github/actions/workflow/status/knuspii/crunchycleaner/go.yml?style=for-the-badge&logo=githubactions&logoColor=white&label=Build&labelColor=111111&color=00c853" alt="Build">
4+
</a>
5+
<a href="https://github.com/knuspii/crunchycleaner/releases">
6+
<img src="https://img.shields.io/github/v/release/knuspii/crunchycleaner?style=for-the-badge&logo=github&logoColor=white&label=Release&labelColor=111111&color=ff6d00" alt="Release">
7+
</a>
8+
<a href="https://github.com/knuspii/crunchycleaner/releases">
9+
<img src="https://img.shields.io/github/downloads/knuspii/crunchycleaner/total?style=for-the-badge&logo=github&logoColor=white&label=Downloads&labelColor=111111&color=8e24aa" alt="Downloads">
10+
</a>
11+
<a href="https://github.com/knuspii/crunchycleaner">
12+
<img src="https://img.shields.io/github/stars/knuspii/crunchycleaner?style=for-the-badge&logo=github&logoColor=white&label=Stars&labelColor=111111&color=fbc02d" alt="Stars">
13+
</a>
914
</p>
1015

1116
<div align="center">
@@ -24,17 +29,21 @@
2429
### Supported Software List:
2530
| Category | Software / Path |
2631
| :--- | :--- |
27-
| **System** | System Logs, System Temp Folders, Thumbnail Cache, Shader Cache |
28-
| **Browsers** | Firefox, Google Chrome, Microsoft Edge, Brave, Opera |
29-
| **Development** | Visual Studio Code, Slack, JetBrains IDE, Go, Pip, NPM, Yarn, Cargo, NuGet, Gradle |
30-
| **Gaming** | Steam, Epic Games(Heroic) |
31-
| **Apps** | Discord, Spotify, Thunderbird, Telegram |
32+
| **System:** | System Logs, System Temp, Thumbnail, Shell History, Package Managers, Shader Cache |
33+
| **Browsers:** | Firefox, Google Chrome, Microsoft Edge, Brave, Opera |
34+
| **Development:** | Visual Studio Code, Slack, JetBrains IDE, Go, Pip, NPM, Yarn, Cargo, NuGet, Gradle |
35+
| **Gaming:** | Steam, Epic Games(Heroic) |
36+
| **Apps:** | Discord, Spotify, Thunderbird, Telegram |
3237

3338
**Flatpak is supported** \
34-
**Snap is not supported**
39+
**Snap is NOT supported**
40+
41+
---
3542

3643
## 📥 How to Install & Download ![Download](https://img.shields.io/github/downloads/knuspii/crunchycleaner/total?color=green)
37-
Paste the corresponding command into your terminal and restart it afterwards. \
44+
**Download the latest binary and just run/open it: [[Download here]](https://github.com/knuspii/crunchycleaner/releases)** \
45+
Or paste the corresponding command into your terminal and restart it afterwards to fully install it. \
46+
\
3847
For Linux (using sudo):
3948
```
4049
curl -L https://github.com/Knuspii/CrunchyCleaner/releases/latest/download/crunchycleaner -o cc && sudo install -m 755 cc /usr/local/bin/crunchycleaner && rm cc
@@ -47,30 +56,24 @@ For Go (using go install):
4756
```
4857
go install github.com/knuspii/crunchycleaner/v2@latest
4958
```
50-
After that you can just type `crunchycleaner -v` into your terminal to verify it's installed. \
51-
52-
Or download the binary and just run/open it:
53-
[[Download here]](https://github.com/knuspii/crunchycleaner/releases)
59+
After that you can just type `crunchycleaner -v` into your terminal to verify it's installed.
5460

5561
---
5662

5763
## Options:
5864
```
5965
-a Automate cleaning (select all and start immediately)
6066
-d Simulation mode without deleting files (for testing)
61-
-t Skip terminal resizing and environment initialization
6267
-v Display version information
6368
```
6469

65-
If you only use a terminal, you might want to use the `-t` flag.
66-
6770
---
6871

6972
> [!WARNING]
7073
> You use this tool at your own risk!
7174
7275
> [!NOTE]
73-
> AI was used for this project in some parts.
76+
> AI was used for this project in some parts. BUT THIS IS NOT VIBECODED!
7477
7578
## Q&A
7679
**Q:** Will this break my system? \
@@ -84,8 +87,11 @@ If you only use a terminal, you might want to use the `-t` flag.
8487

8588
## Other Downloads
8689
CrunchyCleaner is also available on SourceForge \
90+
\
8791
[![Download CrunchyCleaner](https://a.fsdn.com/con/app/sf-download-button)](https://sourceforge.net/projects/crunchycleaner/files/latest/download)
88-
[![Download CrunchyCleaner](https://img.shields.io/sourceforge/dt/crunchycleaner.svg)](https://sourceforge.net/projects/crunchycleaner/files/latest/download)
92+
[![Total Downloads](https://img.shields.io/sourceforge/dt/crunchycleaner.svg)](https://sourceforge.net/projects/crunchycleaner/files/latest/download)
93+
94+
---
8995

9096
### 🎖️ Featured on
9197
[![Awesome TUIs](https://img.shields.io/badge/Awesome-TUIs-orange?style=flat-square)](https://github.com/rothgar/awesome-tuis)

assets/github.png

-4.03 KB
Loading

assets/github.xcf

-281 Bytes
Binary file not shown.

assets/logo.png

-4.4 KB
Loading

assets/logo.xcf

191 KB
Binary file not shown.

0 commit comments

Comments
 (0)