Rewrite README.md changes
This commit is contained in:
parent
076f9629b3
commit
2cb9d7fe13
1 changed files with 21 additions and 20 deletions
37
README.md
37
README.md
|
|
@ -1,28 +1,29 @@
|
||||||
# COSMIC FILE MANAGER
|
# cosmic-files
|
||||||
The New File Manager for Cosmic Desktop written in Rust
|
WIP file manager for the COSMIC desktop environment
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
> It follows the functions and layout of the
|
|
||||||
> classic file manager, simplifies user
|
|
||||||
> operation, and adds many distinctive features.
|
|
||||||
|
|
||||||
> [!NOTE]
|
> [!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
|
```sh
|
||||||
|
# Clone the project using `git`
|
||||||
The Project is written in rust for build the project use `cargo build` for developement unoptimized build
|
git clone https://github.com/pop-os/cosmic-files
|
||||||
or `cargo build --release` for final release build
|
# 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
|
## Community and Contributing
|
||||||
COSMIC is a project with many other software like the file manager but ever-growing community of users and developers
|
|
||||||
|
|
||||||
The main means of contribution and learning:
|
The COSMIC desktop environment is maintained by System76 for use in Pop!_OS. A list of all COSMIC projects can be found in the
|
||||||
* [Pop!_OS Website](https://pop.system76.com)
|
[cosmic-epoch](https://github.com/pop-os/cosmic-epoch) project's README. If you would like to discuss COSMIC and Pop!_OS, please
|
||||||
* [Pop!_OS Chat](https://chat.pop-os.org/)
|
consider joining the [Pop!_OS Chat](https://chat.pop-os.org/). More information and links can be found on the
|
||||||
* [Pop!_OS Documentation](https://support.system76.com/#pop)
|
[Pop!_OS Website](https://pop.system76.com).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This is Project is licensed under [GPLv3](LICENSE)
|
This is Project is licensed under [GPLv3](LICENSE)
|
||||||
Loading…
Add table
Add a link
Reference in a new issue