Rewrite README.md changes

This commit is contained in:
Jeremy Soller 2024-02-20 09:57:04 -07:00
parent 076f9629b3
commit 2cb9d7fe13

View file

@ -1,28 +1,29 @@
# COSMIC FILE MANAGER
The New File Manager for Cosmic Desktop written in Rust
> [!TIP]
> It follows the functions and layout of the
> classic file manager, simplifies user
> operation, and adds many distinctive features.
# cosmic-files
WIP file manager for the COSMIC desktop environment
> [!NOTE]
> This Project is in early development version
> This project is still a work in progress
## Get Started
## Build the project from source
### Build the project from Source Code
The Project is written in rust for build the project use `cargo build` for developement unoptimized build
or `cargo build --release` for final release build
```sh
# Clone the project using `git`
git clone https://github.com/pop-os/cosmic-files
# Change to the directory that was created by `git`
cd cosmic-files
# Build an optimized version using `cargo`, this may take a while
cargo build --release
# Run the optimized version using `cargo`
cargo run --release
```
## Community and Contributing
COSMIC is a project with many other software like the file manager but ever-growing community of users and developers
## Community and Contributing
The main means of contribution and learning:
* [Pop!_OS Website](https://pop.system76.com)
* [Pop!_OS Chat](https://chat.pop-os.org/)
* [Pop!_OS Documentation](https://support.system76.com/#pop)
The COSMIC desktop environment is maintained by System76 for use in Pop!_OS. A list of all COSMIC projects can be found in the
[cosmic-epoch](https://github.com/pop-os/cosmic-epoch) project's README. If you would like to discuss COSMIC and Pop!_OS, please
consider joining the [Pop!_OS Chat](https://chat.pop-os.org/). More information and links can be found on the
[Pop!_OS Website](https://pop.system76.com).
## License
This is Project is licensed under [GPLv3](LICENSE)
This is Project is licensed under [GPLv3](LICENSE)