Get rid of shitty readme #33
Conversation
There was a problem hiding this comment.
Pull request overview
This PR dramatically simplifies the README from a comprehensive 383-line documentation to a concise 188-line quick-reference guide, reducing verbosity by ~50%. The changes aim to streamline documentation while retaining essential information. Additionally, a new aurora-themed shader is added to the examples.
- Condensed installation, configuration, and usage sections to focus on core workflows
- Restructured content with more concise formatting and less promotional language
- Added new "Aurora Dreams" shader for northern lights visualization
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 12 comments.
| File | Description |
|---|---|
| README.md | Major simplification: removed extensive comparison tables, architecture diagrams, and verbose explanations in favor of brief, practical examples and commands |
| examples/shaders/train_interior.glsl | New shader added featuring aurora borealis visualization with mountains, stars, water reflections, and shooting stars |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // Aurora Dreams - Northern Lights over Mountains | ||
| // A mesmerizing aurora borealis with mountain silhouettes and lake reflection |
There was a problem hiding this comment.
The shader file is named "train_interior.glsl" but the comments describe an "Aurora Dreams - Northern Lights over Mountains" shader. The filename does not match the actual content and purpose of the shader. This inconsistency will confuse users trying to select shaders.
| // Aurora Dreams - Northern Lights over Mountains | |
| // A mesmerizing aurora borealis with mountain silhouettes and lake reflection | |
| // Train Interior - Aurora View | |
| // Exterior aurora borealis scene with mountains and lake reflection, as seen from a train interior |
| <table> | ||
| <tr> | ||
| <td width="50%"> | ||
| NeoWall renders **Shadertoy shaders** directly on your desktop. Wayland, X11, multi-monitor, 60fps, ~2% CPU. |
There was a problem hiding this comment.
Missing punctuation at the end of the sentence. The line should end with a period for proper grammar.
| 1. Copy code from shadertoy.com | ||
| 2. Save to `~/.config/neowall/shaders/cool.glsl` | ||
| 3. Config: `shader cool.glsl` | ||
| 4. Done |
There was a problem hiding this comment.
Missing punctuation at the end of the sentence. The line should end with a period for proper grammar.
| 4. Done | |
| 4. Done. |
| - Pure C, single binary | ||
| - GPU does the work, CPU chills | ||
| - timerfd/signalfd — no busy loops | ||
| - Same code runs everywhere |
There was a problem hiding this comment.
Missing punctuation at the end of the sentence. The line should end with a period for proper grammar.
| - Same code runs everywhere | |
| - Same code runs everywhere. |
| - **signalfd** — race-free signal handling | ||
| - **timerfd** — precise frame timing without busy loops | ||
| - **Compositor abstraction** — same codebase for all platforms | ||
| - Pure C, single binary |
There was a problem hiding this comment.
Missing punctuation at the end of the sentence. The line should end with a period for proper grammar.
| - Pure C, single binary | |
| - Pure C, single binary. |
|
|
||
| ## 📦 Installation | ||
| ```bash | ||
| neowall # That's it. You now have an animated wallpaper. |
There was a problem hiding this comment.
Missing punctuation at the end of the sentence. The line should end with a period for proper grammar.
| - **timerfd** — precise frame timing without busy loops | ||
| - **Compositor abstraction** — same codebase for all platforms | ||
| - Pure C, single binary | ||
| - GPU does the work, CPU chills |
There was a problem hiding this comment.
Missing punctuation at the end of the sentence. The line should end with a period for proper grammar.
| - GPU does the work, CPU chills | |
| - GPU does the work, CPU chills. |
| - **Compositor abstraction** — same codebase for all platforms | ||
| - Pure C, single binary | ||
| - GPU does the work, CPU chills | ||
| - timerfd/signalfd — no busy loops |
There was a problem hiding this comment.
Missing punctuation at the end of the sentence. The line should end with a period for proper grammar.
| - timerfd/signalfd — no busy loops | |
| - timerfd/signalfd — no busy loops. |
| --- | ||
|
|
||
| --- | ||
| PRs welcome: shaders, bug fixes, docs, testing. |
There was a problem hiding this comment.
Missing punctuation at the end of the sentence. The line should end with a period for proper grammar.
| PRs welcome: shaders, bug fixes, docs, testing. | |
| PRs welcome: shaders, bug fixes, docs, testing.. |
| vec2 shootDir = normalize(vec2(1.0, -0.5)); | ||
| vec2 shootPos = shootStart + shootDir * shootTime * 2.0; | ||
|
|
||
| float shootDist = length(uv - shootPos); |
There was a problem hiding this comment.
The variable 'shootDist' is calculated but never used. This computation is wasteful and should either be removed or utilized in the shooting star effect logic.
| float shootDist = length(uv - shootPos); |
Description
Type of Change
Related Issues
Fixes #
Testing
Test Configuration
Screenshots/Videos
Checklist
Additional Notes