Update Readme.md

Improved description and about as well as information for updating cflash
This commit is contained in:
2026-04-24 17:09:33 +02:00
parent 5dc7d88b7f
commit e15e7f26d5

View File

@@ -1,15 +1,13 @@
# cflash
Small and lightweight image and iso flasher build on `dd`.
A small and lightweight wrapper for `dd` that strips away the complexity of CLI flashing.
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Java Version](https://img.shields.io/badge/Java-21%2B-orange.svg)](https://www.java.com/en/)
[![Platform](https://img.shields.io/badge/Platform-Linux-brightgreen.svg)](https://www.linux.org/)
[![Status](https://img.shields.io/badge/Status-Beta-red.svg)](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta)
[![Version](https://img.shields.io/badge/version-1.0.0-blue)](https://github.com/Cametendo/cflash-git/releases/tag/cflash-1.0.0)
# About
Java program using `dd` to make flashing iso and image files easier on the terminal. This program allows anyone to flash iso and image files without having to search for extra GUI tools by keeping it simple and resource-friendly.
## Getting Started
Small and lightweight wrapper written in Java for `dd` designed to simplify CLI flashing while protecting your hardware from accidental command-line errors. cflash replaces the syntax with a clear, safe interface, providing a reliable workflow for both newcomers and power users.
# Requirements
- `Java`: 21 (Download [here](https://www.oracle.com/java/technologies/downloads/#java21))
@@ -32,12 +30,19 @@ Java program using `dd` to make flashing iso and image files easier on the termi
mvn clean package
```
3. Run the application:
3. Run cflash:
```bash
java -jar target/cflash-<version>.jar (optionally add arguments here, like with dd)
```
4. Update cflash:
```bash
git pull
mvn clean package
```
### System-wide Installation
To install cflash globally so that it can be run from any terminal:
@@ -55,10 +60,10 @@ To install cflash globally so that it can be run from any terminal:
chmod +x build.sh install.sh
```
3. Build the project using the provided build script:
3. Build the project using the provided build script (requires root privileges):
```bash
./build.sh
sudo ./build.sh
```
4. Install globally (requires root privileges):
@@ -73,6 +78,12 @@ To install cflash globally so that it can be run from any terminal:
cflash
```
6. Update cflash (reguires root privileges):
```bash
sudo cflash --update
```
**Notes:**
* The `build.sh` script compiles all Java source files and creates an executable `cflash.jar`.
@@ -85,6 +96,12 @@ To install cflash globally so that it can be run from any terminal:
cd cflash
makepkg -si
```
* You can update cflash using `yay` / `paru` via `yay -S cflash` / `paru -S cflash` or by rebuilding the package:
```bash
git clone https://aur.archlinux.org/cflash.git
cd cflash
makepkg -si
```
# Usage
- Using the command `cflash` in the terminal, will start the flashing process. You will be asked several question before the flashing begins: