cosmic-edit/README.md

21 lines
988 B
Markdown
Raw Normal View History

2024-03-13 09:50:47 -06:00
# COSMIC Text Editor
Text editor for the COSMIC desktop
![Screenshot](res/screenshots/screenshot-1.png)
2023-03-14 14:56:58 -06:00
Currently an incomplete **pre-alpha**, this project is a work in progress - issues are expected.
## Testing
You can test by installing a current version of Rust and then building with `cargo`.
```SHELL
git clone https://github.com/pop-os/cosmic-edit
cd cosmic-edit
cargo build
```
2024-02-02 19:57:07 +01:00
You can get more detailed errors by using the `RUST_LOG` environment variables, that you can invoke for just that one command like this: `RUST_LOG=debug cargo run`. This will give you more detail about the application state. You can go even further with `RUST_LOG=trace cargo run`, that shows all logging details about the application.
## Clippy Lints
2024-02-02 19:57:07 +01:00
PRs are welcome, as it builds a better product for everyone. It is recommended that you check your code with Clippy Lints turned on. You can find more about [Configuring Clippy](https://doc.rust-lang.org/nightly/clippy/configuration.html) here.