docs: Professional GitHub README with game info and instructions

2026-01-28 14:13:02 +01:00
parent ecf5b9e9c4
commit 3b12075be3
1 changed files with 114 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,114 @@
-# carrot-hunter
+# 🥕 Carrot Hunter
+
+A delightful retro-style platformer game for Chromebook and desktop browsers. Help a hungry bunny collect all the carrots while avoiding enemies!
+
+## ✨ Features
+
+- **Simple but challenging** - 3 levels with increasing difficulty
+- **Zero dependencies** - Pure HTML5 Canvas, no frameworks or external libraries
+- **Works offline** - Download and play anytime, anywhere
+- **Cross-platform** - Chromebook, Windows, Mac, Linux - any modern browser
+- **Colorful graphics** - Bright, appealing visuals for all ages
+- **Responsive controls** - Smooth WASD or arrow key movement
+
+## 🚀 Quick Start
+
+### On Chromebook
+1. Download `Carrot_Hunter_Final.zip` from [Releases](../../releases)
+2. Extract the ZIP file
+3. Double-click `carrot_hunter.html`
+4. Game opens in Chrome automatically
+5. Play! 🎮
+
+### On Windows/Mac/Linux
+1. Download `Carrot_Hunter_Final.zip` from [Releases](../../releases)
+2. Extract the ZIP file
+3. Double-click `carrot_hunter.html` or drag into your browser
+4. Enjoy! 🎮
+
+## 🎮 How to Play
+
+- **Arrow Keys** or **WASD** - Move left/right
+- **Space Bar**, **Arrow Up**, or **W** - Jump
+- **Goal** - Collect all orange carrots on each level
+- **Avoid** - Red enemies will end your game
+- **Levels** - Complete all 3 levels to win!
+
+## 🎯 Gameplay Tips
+
+- Use platform edges strategically
+- Jump over enemies when possible
+- Take your time - there's no time limit
+- You have unlimited lives - practice makes perfect!
+- Each level gets progressively harder
+
+## 📦 Package Contents
+
+```
+Carrot_Hunter_Final/
+├── carrot_hunter.html      # The complete game (19 KB)
+├── README.md               # This file
+├── INSTALLATION.md         # Detailed setup guide
+├── DEPENDENCIES.md         # Technical details
+└── START_HER.txt          # Quick reference guide
+```
+
+## 🌟 Game Features
+
+### Level 1: Begyndelse (The Beginning)
+- Simple introduction level
+- No enemies
+- Perfect for learning controls
+
+### Level 2: Fjender (Enemies)
+- First enemies appear
+- Medium difficulty
+- Learn to navigate around threats
+
+### Level 3: Udfordring (Challenge)
+- Complex platform layouts
+- Multiple enemies
+- True test of skill
+
+## 💡 What Makes It Special
+
+✅ **No Installation** - Just download and play  
+✅ **No Internet Required** - Works completely offline  
+✅ **No Ads or Tracking** - 100% clean, pure game  
+✅ **Works Everywhere** - Any browser, any OS  
+✅ **Open Source** - Code is visible and modifiable  
+
+## 🔮 Future Versions
+
+Check out the **`v2-20-levels`** branch for an expanded version with 20 levels and additional challenges!
+
+## 📝 License
+
+This game is created as a fun project. Feel free to play, share, and modify!
+
+## 🛠️ Technical Details
+
+- **Language**: HTML5, CSS3, JavaScript (Canvas API)
+- **Size**: ~19 KB (tiny!)
+- **Browser Support**: Chrome, Firefox, Safari, Edge (all modern versions)
+- **Performance**: 60 FPS on all devices
+
+## 🤝 Contributing
+
+Want to help improve the game? 
+- Report bugs in the Issues section
+- Suggest features
+- Share your high scores!
+
+## 📞 Support
+
+For questions or issues:
+1. Check [INSTALLATION.md](Carrot_Hunter_Final/INSTALLATION.md) for setup help
+2. Read [DEPENDENCIES.md](Carrot_Hunter_Final/DEPENDENCIES.md) for technical info
+3. Review [START_HER.txt](Carrot_Hunter_Final/START_HER.txt) for quick reference
+
+---
+
+**Made with ❤️ for Chromebook players everywhere**
+
+Ready to hunt carrots? [Download now!](../../releases)