From 704940bc07b516a5fb0ef9fb37feaa6f00cfafaa Mon Sep 17 00:00:00 2001 From: Noel24Dav <143480946+Noel24Dav@users.noreply.github.com> Date: Tue, 24 Mar 2026 18:02:12 +0300 Subject: [PATCH] Update README.mddocs: expand README with project overview and getting started guide The previous README contained only a single line with no useful information for contributors or new users. Changes made: - Added What is BOS section - Added Features section - Added Project Structure section - Added Getting Started with prerequisites and installation - Added Self Hosting section - Added Contributing guidelines - Added License and Contact sections Closes #<44> --- README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2973e74..7ad12ab 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,66 @@ # BOS -BOS (Bugema Operating System) the internet OS! Free, Open Source, Self hostable +BOS (Bugema Operating System) is the internet OS — free, open source, and self-hostable. + +## What is BOS? +BOS is a web-based operating system built and maintained by the Bugema Open Source Community. It aims to provide a full desktop-like experience accessible from any browser, with the freedom to self-host on your own infrastructure. + +## Features +- Browser-based OS experience +- Free and open source +- Self-hostable on your own server +- Community-driven development + +## Project Structure +``` +BOS/ +├── src/ # Core source code +├── docs/ # Documentation +├── public/ # Static assets +└── README.md # Project overview +``` + +## Getting Started + +### Prerequisites +- Node.js 18+ +- Docker & Docker Compose (recommended) + +### Installation +```bash +git clone https://github.com/bos-com/BOS.git +cd BOS +``` + +### Running Locally +```bash +npm install +npm start +``` +The app will be available at `http://localhost:3000` + +## Self Hosting +Detailed self-hosting instructions coming soon. See `docs/` for available guides. + +## Contributing +1. Fork the repository +2. Create a feature branch: `git checkout -b feature/your-feature` +3. Commit your changes with clear messages +4. Submit a pull request + +## License +This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details. + +## Contact +- Community: [Bugema Open Source Community](https://github.com/bos-com) +- Issues: Use GitHub Issues for bug reports and feature requests +``` + +--- + +## Commit the Changes + +Scroll down to **"Commit changes"** and fill in: + +**Commit message:** +``` +docs: expand README with project overview and getting started guide