README.md much better for external developers to read

The original README.md was very bad, it doesn't clearly explain what the project was, I wrote a new one that is quite simple but explains the project better
This commit is contained in:
Luiz Henrique Amaral Soares 2024-02-11 17:15:47 -03:00 committed by Jeremy Soller
parent a24983ca7f
commit 2279df8cac

View file

@ -1,2 +1,22 @@
# cosmic-files
WIP COSMIC file manager
# COSMIC FILE MANAGER
The News File Manager for Cosmic Desktop write in Rust
> [!NOTE]
> This Project is in early development version
## Get Started
### Build the project
The Project is write in rust for build the project use `cargo build` for developement unoptimized build
or `cargo build --release` for final release build
## Feactures
- [X] Basic File Navigation
- [X] Many Languages translation
- [X] Low Memory requirements
- [X] Rust Based Software
# Contributing
COSMIC is a project with many other software like the file manager but ever-growing community of users and developers
The Best way to get in touch with the core developers is in [Pop!_OS Chat](https://chat.pop-os.org/)