From 2279df8cac1e6ef234927a9da7a329a985a45717 Mon Sep 17 00:00:00 2001 From: Luiz Henrique Amaral Soares <79329499+LuizHenriqueAmaralSoares-lab@users.noreply.github.com> Date: Sun, 11 Feb 2024 17:15:47 -0300 Subject: [PATCH] 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 --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ec38252..42d001b 100644 --- a/README.md +++ b/README.md @@ -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/)