Skip to content

Commit 23bd36f

Browse files
Update README.md
1 parent 336efd5 commit 23bd36f

File tree

1 file changed

+128
-1
lines changed

1 file changed

+128
-1
lines changed

README.md

Lines changed: 128 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,128 @@
1-
# Enable-Disable-Compressed-RAM-Memory-Tool
1+
# 🧠 Compressed Memory Control Tool
2+
3+
![Main UI Screenshot](./screenshots/main-ui.png) <!-- Replace with actual screenshot path -->
4+
5+
---
6+
7+
## 📌 Overview
8+
9+
**Compressed Memory Control Tool** is a beautifully designed Windows desktop application that allows users to **view**, **enable**, or **disable** Windows’ built-in **Compressed Memory** feature with a single click — no scripting knowledge needed.
10+
11+
> ✨ Built for non-technical users who want **performance control** without touching PowerShell or CMD.
12+
13+
---
14+
15+
## 📸 Screenshots
16+
17+
| Feature | Screenshot |
18+
|--------|------------|
19+
| ✅ Main Interface | ![Main UI](./screenshots/main-ui.png) |
20+
| 🔍 Check Status | ![Check Status](./screenshots/check-status.png) |
21+
| ❌ Disable Compression | ![Disable](./screenshots/disable.png) |
22+
| ✔️ Enable Compression | ![Enable](./screenshots/enable.png) |
23+
24+
---
25+
26+
## 🚀 Features
27+
28+
- 🔍 **Check if Compressed Memory is enabled**
29+
-**Disable Compressed Memory** for high-RAM systems
30+
-**Enable Compressed Memory** for low-RAM optimization
31+
- 🛡️ **Admin auto-elevation** built-in
32+
- 🧩 **One-click UI interface** – no PowerShell scripting required
33+
-**Buy Me A Coffee** support button
34+
- 💜 **GitHub Tools button** to explore more utilities
35+
- 📦 Fully self-contained **`.exe`** — just run and use
36+
37+
---
38+
39+
## 🤔 What is Compressed Memory?
40+
41+
Windows uses a feature called **Compressed Memory** to reduce the size of less-used data in RAM instead of writing it to disk. This can improve responsiveness for low-memory systems.
42+
43+
### When should you enable it?
44+
45+
✔️ **Enable if**:
46+
- You have **4GB to 16GB** of RAM
47+
- You often run multiple programs
48+
- You want smoother multitasking
49+
50+
**Disable if**:
51+
- You have **32GB, 64GB or more** RAM
52+
- You want **maximum performance** without compression overhead
53+
- You prefer manual RAM control for AI, gaming, video rendering, etc.
54+
55+
ℹ️ This app applies changes instantly. **A restart is recommended** for the changes to take full effect.
56+
57+
---
58+
59+
## 🛠️ How to Use
60+
61+
1. **Download the `.exe` file** (or clone the repo and build it yourself).
62+
2. **Double-click to launch** – it will **ask for admin rights** (required by Windows).
63+
3. Use the following buttons:
64+
- **Check Status** – Shows current memory compression state.
65+
- **Disable Compression** – Turns off Windows memory compression.
66+
- **Enable Compression** – Turns on memory compression.
67+
4. Review the output in the log box.
68+
5. (Optional) Click on:
69+
-**Buy Me A Coffee** if you found the tool useful.
70+
- 💜 **GitHub** to check out more scripts and tools by the developer.
71+
72+
---
73+
74+
## 📦 Building from Source
75+
76+
> Requires Python 3.10+, `pyinstaller`, and `tkinter`.
77+
78+
### 🔧 Installation
79+
80+
```bash
81+
pip install pyinstaller
82+
````
83+
84+
### 🧪 Compile to EXE
85+
86+
```bash
87+
pyinstaller --noconfirm --onefile --windowed --icon "Personal_Picture.ico" --add-data "Personal_Picture.ico;." compressed_memory_gui.py
88+
```
89+
90+
---
91+
92+
## 🧑‍💻 Developer
93+
94+
**Made with ❤️ by Mohammed Kashan Tariq**
95+
96+
This tool was created to help **non-technical users** control an advanced system setting — safely and easily.
97+
98+
> 🙌 Feel free to fork this project, give feedback, or contribute improvements!
99+
100+
---
101+
102+
## 📂 Repository Structure
103+
104+
```bash
105+
📁 Compressed-Memory-Control-Tool/
106+
├── compressed_memory_gui.py # Main Python GUI application
107+
├── Personal_Picture.ico # Icon for window and taskbar
108+
├── *.ps1 # (Optional) PowerShell backup scripts
109+
├── dist/ # PyInstaller output
110+
├── screenshots/ # UI screenshots for README
111+
├── README.md # This file
112+
```
113+
114+
---
115+
116+
## 🥤 Support
117+
118+
If you like this tool and want to keep more free tools coming:
119+
120+
☕ [**Buy Me a Coffee**](https://coindrop.to/mr-shan)
121+
122+
---
123+
124+
## 📄 License
125+
126+
This tool is provided **free of charge** under the MIT License. Feel free to use, modify, and distribute — but please give credit where due.
127+
128+

0 commit comments

Comments
 (0)