Skip to content

Commit 8960867

Browse files
committed
Update README
1 parent c82fa6d commit 8960867

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# openFyde Overlay for XpressReal T3
2+
3+
This repository contains the openFyde overlay for the XpressReal T3 single-board computer (SBC). It provides the necessary configurations and packages to build a openFyde image specifically for this hardware platform.
4+
5+
## About XpressReal T3
6+
7+
The XpressReal T3 is a single-board computer designed for various applications. For detailed hardware specifications, features, and technical documentation, please visit the [XpressReal Wiki](https://wiki.xpressreal.io).
8+
9+
## About this Overlay
10+
11+
This overlay is part of the OpenFyde project and extends the openFyde build system with XpressReal T3-specific configurations. It includes:
12+
13+
- Board-specific configurations
14+
- Hardware-optimized kernel settings
15+
- Device drivers and firmware
16+
- Platform-specific package modifications
17+
18+
## Building openFyde for XpressReal T3
19+
20+
To build a openFyde image for the XpressReal T3 using this overlay, please follow the comprehensive build guide available at:
21+
22+
**[XpressReal Building OpenFyde Guide](https://wiki.xpressreal.io/guides/building-openfyde/)**
23+
24+
The guide covers:
25+
- Setting up the build environment
26+
- Configuring the build system
27+
- Using this overlay in your build
28+
- Building and deploying the image
29+
30+
## Directory Structure
31+
32+
- `chromeos-base/`: Board-specific ebuilds for core openFyde packages
33+
- `make.conf`: Board-specific make settings and compilation flags
34+
- `metadata/`: Repository metadata including overlay dependencies
35+
- `profiles/`: Portage profiles and configuration for the XpressReal T3
36+
- `virtual/`: Virtual packages for dependency management
37+
38+
## Requirements
39+
40+
- ChromiumOS build environment
41+
- OpenFyde build system
42+
- All dependent overlays listed above
43+
44+
## Support
45+
46+
For hardware-specific questions, technical support, and additional documentation:
47+
- Visit the [XpressReal Wiki](https://wiki.xpressreal.io)
48+
- Follow the [Building OpenFyde Guide](https://wiki.xpressreal.io/guides/building-openfyde/)
49+
50+
## Contributing
51+
52+
Contributions to improve XpressReal T3 support are welcome. Please:
53+
1. Fork this repository
54+
2. Create a feature branch
55+
3. Test your changes thoroughly
56+
4. Submit a pull request with a clear description
57+
58+
## License
59+
60+
This overlay follows the same licensing terms as the ChromiumOS project and OpenFyde.

0 commit comments

Comments
 (0)