doc:s: add documentation and complete the readme
All checks were successful
build and upload / build (push) Successful in 16s
All checks were successful
build and upload / build (push) Successful in 16s
This commit is contained in:
37
README.md
37
README.md
@@ -1,3 +1,38 @@
|
||||
# feddy
|
||||
|
||||
Your awesome, friendly, lightning-fast, and super-easy-to-use Fedora Buddy !
|
||||
Your awesome, friendly, lightning-fast, and super-easy-to-use Fedora Buddy !
|
||||
|
||||
## Usage
|
||||
|
||||
This project is a command line tool that helps you to manage your Fedora system. You can use it to install or remove package lists, as well as to perform other post installation tasks.
|
||||
|
||||
Please refer to the [DOCUMENTATION.md](DOCUMENTATION.md) file for more information on how to use the tool.
|
||||
|
||||
## Install on Fedora
|
||||
|
||||
Please refer to project's [releases](https://git.rawleenc.dev/rawleenc/feddy/releases), copy the RPM package link of the latest version and install it with dnf.
|
||||
|
||||
## Build from source
|
||||
|
||||
This is a Rust project, so you must first install [Rust](https://www.rust-lang.org/tools/install) and then run the following command to build the project:
|
||||
|
||||
```bash
|
||||
./configure
|
||||
make
|
||||
```
|
||||
|
||||
## Install from source
|
||||
|
||||
You can install the project by running the following command:
|
||||
|
||||
```bash
|
||||
sudo make install
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
You can run the project in development mode by running the following command:
|
||||
|
||||
```bash
|
||||
cargo run -- ${args}
|
||||
```
|
||||
Reference in New Issue
Block a user