diff --git a/README.md b/README.md index 630959d..c0b8989 100644 --- a/README.md +++ b/README.md @@ -6,84 +6,66 @@ [![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md) [![Discord](https://img.shields.io/discord/1320414880956571719?color=7289da&label=Discord&logo=discord)](https://discord.gg/8eZfFWhczz) -**Comprehensive, community-driven documentation for the AMD BC250 board** โ€” a compact AMD "Cyan Skillfish" APU platform originally designed for cryptocurrency mining, repurposed by the community as a capable Linux gaming and desktop system. +**Comprehensive, community-driven documentation for the AMD BC250 board.** -๐Ÿ“– **Read the docs:** [elektricM.github.io/amd-bc250-docs](https://elektricM.github.io/amd-bc250-docs/) +๐Ÿ“– **Read the docs:** [https://elektricM.github.io/amd-bc250-docs/](https://elektricM.github.io/amd-bc250-docs/) ---- +โœ๏ธ **Contribute:** Found a solution? Add it to the docs so everyone can find it! See [CONTRIBUTING.md](CONTRIBUTING.md) -## What's Inside +## What's Included -| Section | Description | -|---|---| -| [Getting Started](https://elektricM.github.io/amd-bc250-docs/getting-started/quick-start/) | Board intro, prerequisites, quick setup checklist | -| [Linux Setup](https://elektricM.github.io/amd-bc250-docs/linux/fedora/) | Guides for Fedora, Bazzite, CachyOS, Arch, Debian, and more | -| [BIOS & Firmware](https://elektricM.github.io/amd-bc250-docs/bios/flashing/) | Flashing, configuration, GPU frequency patch (P3.00) | -| [Hardware](https://elektricM.github.io/amd-bc250-docs/hardware/specs/) | Power, cooling, display compatibility, pinouts | -| [Gaming & Performance](https://elektricM.github.io/amd-bc250-docs/gaming/compatibility/) | Tested games, FPS data, settings | -| [Drivers (RADV)](https://elektricM.github.io/amd-bc250-docs/drivers/radv/) | RADV configuration, Mesa version requirements | -| [System Configuration](https://elektricM.github.io/amd-bc250-docs/system/governor/) | GPU governor, power management, sensors | -| [Community Cases](https://elektricM.github.io/amd-bc250-docs/community/cases/) | 145 case and enclosure designs โ€” searchable and filterable | -| [Troubleshooting](https://elektricM.github.io/amd-bc250-docs/troubleshooting/stability/) | Boot issues, performance problems, display fixes | - ---- - -## Community Cases Catalogue - -**145 case and enclosure designs** documented from Discord, Reddit, Printables, MakerWorld, and Thingiverse โ€” filterable by PSU type, availability, and platform. - -โžœ [Browse the catalogue](https://elektricM.github.io/amd-bc250-docs/community/cases/) - ---- - -## Stats - -- **1000+ Discord community members** contributing real-world testing -- **9,716 technical messages** analyzed from the BC250 Discord -- **30+ games tested** with performance data and settings -- **7 Linux distributions** with dedicated setup guides -- **145 case designs** catalogued from the community -- **Last updated:** March 2026 - ---- +- **Linux setup guides** for 7+ distributions (Fedora, Bazzite, CachyOS, Arch, Debian, etc.) +- **BIOS flashing** and configuration (including GPU frequency patch) +- **Hardware specs** - power requirements, cooling, display compatibility +- **Troubleshooting** - boot issues, performance problems, stability fixes +- **Gaming compatibility** - tested games, settings, FPS data +- **Driver setup** - RADV configuration, environment variables +- **Community cases catalogue** - 145 case/enclosure designs, searchable and filterable +- **System configuration** - GPU governor (cyan-skillfish-governor-tt default, oberon-governor alternative), sensors, power management ## Building Locally ```bash +# Install dependencies pip install mkdocs-material -mkdocs serve # live preview at http://127.0.0.1:8000/ -mkdocs build # build static site to ./site/ + +# Serve locally with live reload +mkdocs serve + +# Build static site +mkdocs build ``` ---- +The site will be available at http://127.0.0.1:8000/ + +## Content Sources + +Built from: +- BC250 Discord community (9,716 technical messages from 1000+ members) +- [BC250 GitHub repository](https://github.com/mothenjoyer69/bc250-documentation) +- Last Updated: March 16, 2026 ## Contributing -Solutions posted in Discord get buried. Put them in the docs instead โ€” everyone finds them forever. +**Please contribute your knowledge!** Instead of posting solutions in Discord where they get lost, add them to the documentation: -- **Quick edit:** Click "Edit on GitHub" on any page -- **Report errors:** [Open an issue](https://github.com/elektricM/amd-bc250-docs/issues) -- **Full guide:** [CONTRIBUTING.md](CONTRIBUTING.md) +- **Easy way:** Click "Edit on GitHub" on any page and submit changes +- **Report issues:** Found wrong info? [Open an issue](https://github.com/elektricM/amd-bc250-docs/issues) +- **Full guide:** See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed instructions -**What's needed most:** -- Tested hardware configurations and PSU combinations -- Game compatibility reports (especially newer titles) -- Distribution-specific quirks and fixes -- Case/enclosure designs for the [community catalogue](https://elektricM.github.io/amd-bc250-docs/community/cases/) +**What we need:** +- โœ… Tested hardware configurations +- โœ… Game compatibility reports +- โœ… Troubleshooting solutions you've found +- โœ… Distribution-specific setup steps +- โœ… Fixes for outdated information -**Discord:** [discord.gg/8eZfFWhczz](https://discord.gg/8eZfFWhczz) - ---- - -## Sources - -- BC250 Discord community (9,716 messages from 1000+ members) -- [mothenjoyer69/bc250-documentation](https://github.com/mothenjoyer69/bc250-documentation) -- Community-contributed testing and documentation +**Join Discord:** [https://discord.gg/8eZfFWhczz](https://discord.gg/8eZfFWhczz) - but please document your solutions here! ## License -Documentation: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) ยท Code: [MIT](LICENSE) +- Documentation: CC BY-SA 4.0 +- Code: MIT ---