Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 65 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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