MarineComOS_RPI/README.md

27 lines
1.3 KiB
Markdown

# MarineComOS RPI
MarineComOS RPI is a customized operating system for Raspberry Pi, designed specifically for marine applications. It is based on Raspberry Pi OS and built using pi-gen, with added configurations and tools to streamline onboard operations.
## Key Features
- **Headless Operation**: SSH enabled by default with preconfigured networking.
- **Preloaded Docker Containers**:
- **Portainer** for container management.
- **SignalK** for marine data integration.
- **Filesystem Layout**:
- Read-only root filesystem for stability.
- Writable partition for Docker data and application dependencies.
## Getting Started
- **Download the Image**: Obtain the latest release from [MarineComOS RPI Releases](http://git.relentnet.com/Relentnet/MarineComOS_RPI).
- **Flash the Image**: Use tools like Raspberry Pi Imager or balenaEtcher to flash the `.img` file onto an SD card.
- **First Boot**: Insert the SD card into your Raspberry Pi and power it on.
## Documentation
Detailed setup and usage instructions are available in the repository's [Wiki](http://git.relentnet.com/Relentnet/MarineComOS_RPI/wiki).
## Contributing
Contributions are welcome! Open issues or submit pull requests for suggestions and improvements.
## License
MarineComOS RPI is licensed under the MIT License. See [LICENSE](LICENSE) for details.