86 lines
1.5 KiB
Markdown
86 lines
1.5 KiB
Markdown
# R_EoM
|
|
|
|
R_EoM is a library with a demo platform for testing and showcasing its features.
|
|
|
|
## Project Structure
|
|
|
|
- `src/lib.rs`: The core library logic.
|
|
- `src/main.rs`: The demo platform application.
|
|
- `tests/`: Integration tests.
|
|
- `flatpak/`: Flatpak manifest for the demo platform.
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Rust and Cargo
|
|
- (Optional) Flatpak and Flatpak Builder
|
|
|
|
### Building and Running
|
|
|
|
To build the project:
|
|
|
|
```bash
|
|
cargo build
|
|
```
|
|
|
|
To run the demo platform:
|
|
|
|
```bash
|
|
cargo run --bin r_eom_demo
|
|
```
|
|
|
|
To run tests:
|
|
|
|
```bash
|
|
cargo test
|
|
```
|
|
|
|
### Nix
|
|
|
|
This project provides Nix support via flakes and a traditional `default.nix`.
|
|
|
|
To build the project using Nix:
|
|
|
|
```bash
|
|
nix build
|
|
```
|
|
|
|
To run the demo platform using Nix:
|
|
|
|
```bash
|
|
nix run
|
|
```
|
|
|
|
To enter a development shell:
|
|
|
|
```bash
|
|
nix develop
|
|
```
|
|
|
|
(or `nix-shell` for non-flake users)
|
|
|
|
### Flatpak
|
|
|
|
To build the Flatpak:
|
|
|
|
```bash
|
|
make flatpak-build
|
|
```
|
|
|
|
## IDE Support
|
|
|
|
### RustRover / IntelliJ Rust
|
|
|
|
This project includes shared run configurations in the `.run` directory. When you open the project in RustRover or IntelliJ IDEA with the Rust plugin, these configurations will automatically appear in the Run/Debug dropdown:
|
|
|
|
- **Run Demo**: Executes the `r_eom_demo` binary.
|
|
- **Run Tests**: Executes all tests in the workspace.
|
|
|
|
Additionally, the IDE automatically detects all targets defined in `Cargo.toml`.
|
|
|
|
## License
|
|
|
|
This project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License - see the [LICENSE](LICENSE) file for details.
|
|
|