From 005b396ee393a53abfe0af080ed13eaf12773e98 Mon Sep 17 00:00:00 2001 From: Cametendo Date: Fri, 6 Feb 2026 09:50:51 +0100 Subject: [PATCH] Revise README for cflash project details Updated project name and expanded README with details about usage, requirements, installation, and supported OS. --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e427162..624127a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# image-flasher -Small and lightweight image and iso flasher build on dd +# cflash +Small and lightweight image and iso flasher build on `dd`. + +# 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 and by keeping it simple and resource-friendly. + +# Requirements +- `Java`: 21 (Download [here](https://www.oracle.com/java/technologies/downloads/#java21) +- `util-linux`: 2.41 +- `coreutils`: 9.10 + +# Usage +- Using the command `cflash` in the terminal, will start the flashing process. You will be asked several question before the flashing begins: + 1. You will see a list of every drive your system see's (excluding system drives) and the be asked to enter the device you want to flash the image onto. (F.e. **/dev/sda**) + 2. You will be prompted to enter the path of the iso / image you want to flash + 3. You will be prompted to choose a byte size (default: 4M) + 4. You will be prompted to enter your oflag (default: direct) + 5. You will be asked if you are absolutely sure that you want to continue (flashing will wipe all data) +- Alternative: using `cflash [device] [iso-path] [block-size] [oflag]` will skip the first question and instantly ask you, if you're absolutely sure you want to continue. +- Once confirmed, the flash will start and a small progress bar will appear showing the flashing progress. +- After completion, the program will detect the OS from the iso and wish you a great time with your new OS. (Example: "Done! Have fun with your new Linux installation!) +- **IMPORTANT**: Since dd needs sudo rights, ensure you have root priviliges. + +# Supported OS +- Linux, MacOS, FreeBSD + +# Installation +1. Clone the repository onto your local device. +2. Run the `build.sh` file to build the program. +3. Run the `ìnstall.sh`to install the program. +4. Open a terminal and use the program with `cflash`. + +# License and Credits +**Author**: [Cametendo](https://www.github.com/Cametendo) +**License**: MIT