Skip to content

Free, open-source Windows optimization tool for performance, privacy, and simplicity.

docs: rework markdowns

itsfatduck1b23c6bf8228
diff --git a/Docs/acknowledgments.md b/Docs/acknowledgments.md
index 740fe09..d1f168c 100644
--- a/Docs/acknowledgments.md
+++ b/Docs/acknowledgments.md
@@ -9,17 +9,20 @@ Special thanks to the **libraries**, **projects**, and **community members** who
</div>
## πŸ“š Libraries
+
- [Spectre.Console](https://spectreconsole.net/) β€” modern console UI library for .NET
- [Serilog](https://serilog.net/) β€” flexible logging framework
- [vertical-spectreconsolelogger](https://github.com/verticalsoftware/vertical-spectreconsolelogger/) β€” customizable Spectre Console provider
- [Microsoft Docs](https://docs.microsoft.com/en-us/) β€” official documentation for Windows and .NET
## πŸ› οΈ Projects
+
- [WinUtil](https://github.com/ChrisTitusTech/winutil) β€” Windows optimization scripts and tools
- [OneClick](https://github.com/QuakedK/Oneclick) β€” debloat Windows by disabling telemetry and unnecessary services
- Other open-source projects that inspired tweaks and ideas
## πŸ‘₯ Community & Users
+
- Everyone who starred ⭐ the project
- GitHub contributors (issues, discussions, PRs)
- Discord members for feedback and support
diff --git a/Docs/faq.md b/Docs/faq.md
index 7c21f8c..f9d5e24 100644
--- a/Docs/faq.md
+++ b/Docs/faq.md
@@ -2,7 +2,7 @@
<img src="../.github/assets/optimizerDuck.png" alt="optimizerDuck Banner" title="optimizerDuck" height="300"/>
-# FAQ: Safety & Usage
+# FAQ
View answers to common questions about optimizerDuck and its safety.
@@ -15,6 +15,7 @@ It does not contain malware, spyware, or hidden installers.
All tweaks are transparent and documented in this repository.
For peace of mind:
+
- Review the source code in [GitHub](../).
- Build the project yourself from source.
- Check the [Safety Guidelines](safety.md).
@@ -22,5 +23,6 @@ For peace of mind:
## Why does optimizerDuck restart the app every time I open it?
**optimizerDuck** requires a restart on each launch because:
+
- Administrator permissions are always needed to apply system-level tweaks.
-- The app opens in a maximized window so all options are clearly visible.
\ No newline at end of file
+- The app opens in a maximized window so all options are clearly visible.
diff --git a/Docs/getting-started.md b/Docs/getting-started.md
index 96e466a..dff6672 100644
--- a/Docs/getting-started.md
+++ b/Docs/getting-started.md
@@ -8,10 +8,6 @@ This is a step-by-step guide to help you get started with optimizerDuck.
</div>
-## Requirements
-- Windows 10 or 11 (x64)
-- Administrator privileges
-
## Download
1. [Download the latest release](https://github.com/itsfatduck/optimizerDuck/releases/latest).
@@ -28,6 +24,7 @@ This is a step-by-step guide to help you get started with optimizerDuck.
2. Restart your PC for tweaks to take effect.
## Uninstall
+
optimizerDuck is portable.
To uninstall, simply delete the `.exe` file and related config/logs in `%APPDATA%/optimizerDuck/`.
diff --git a/Docs/index.md b/Docs/index.md
index fe3b8b1..f476641 100644
--- a/Docs/index.md
+++ b/Docs/index.md
@@ -6,7 +6,7 @@
</div>
-Welcome to the **optimizerDuck** documentation!
+Welcome to the **optimizerDuck** documentation!
Here you will find information about how to use **optimizerDuck**, as well as information about the project and its features.
@@ -14,6 +14,6 @@ Here you will find information about how to use **optimizerDuck**, as well as in
- [Getting Started](getting-started.md)
- [Safety](safety.md)
-- [FAQ: Safety & Usage](faq.md)
+- [FAQ](faq.md)
- [Acknowledgments](acknowledgments.md)
-- [Features](features.md)
\ No newline at end of file
+- [Features](features.md)
diff --git a/Docs/safety.md b/Docs/safety.md
index 6a51237..580e20c 100644
--- a/Docs/safety.md
+++ b/Docs/safety.md
@@ -2,20 +2,24 @@
<img src="../.github/assets/optimizerDuck.png" alt="optimizerDuck Banner" title="optimizerDuck" height="300"/>
-# Safety Guidelines
+# Safety
Follow these safety guidelines to ensure a secure and smooth experience.
</div>
## Safety Guidelines
+
These are steps users should follow to ensure safe usage:
+
- Always create a restore point when prompted.
- Grant administrator permissions when requested.
- Restart your PC after applying tweaks.
## Safety Features
+
optimizerDuck is built with safety in mind. Key features include:
+
- **Ask for restore points** before making changes.
- **Extensive testing** on various hardware configurations.
- **Open source** β€” you can inspect every line of code.
diff --git a/README.md b/README.md
index 92196c6..c54a3d0 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@
1. [Quick Start](#quick-start)
2. [Documentation](#documentation)
-3. [Features](#features)
+3. [Key Optimizations](#key-optimizations)
4. [Mindset Matters](#mindset-matters)
5. [Why I Built optimizerDuck](#why-i-built-optimizerduck)
6. [Community & Support](#community--support)
@@ -39,14 +39,8 @@
1. [Download the latest release](https://github.com/itsfatduck/optimizerDuck/releases/latest)
2. Run the `.exe` file
-3. Restart your PC for some tweaks to take effect
-### Requirements
-
-This is which optimizerDuck has been tested on:
-
-- [![OS](https://img.shields.io/badge/OS-Windows_10_or_11_x64-0078d4)](https://www.microsoft.com/en-us/software-download/)
-- [![.NET](https://img.shields.io/badge/.NET_Runtime-10.0_Latest-ef99dd)](https://dotnet.microsoft.com/en-us/download)
+> **Note:** Restart your PC for some tweaks to take effect
### Documentation