1.1.07 release

[Ventoy.git] / INSTALL / README

diff --git a/INSTALL/README b/INSTALL/README
index fad0c0bcadce7e897356ad1d375597eb38c25f4e..989e10ade11e01fab91b0f03b948faebe3fbe92e 100644 (file)
--- a/INSTALL/README
+++ b/INSTALL/README
@@ -1,7 +1,7 @@
 
 ========== Ventoy2Disk.sh ===============
 
 
 ========== Ventoy2Disk.sh ===============
 

-sudo sh Ventoy2Disk.sh { -i | -I | -u } /dev/XXX   XXX is the USB device, for example /dev/sdb.
+sudo bash Ventoy2Disk.sh { -i | -I | -u } /dev/sdX   sdX is the USB device, for example /dev/sdb.

 
 Ventoy2Disk.sh CMD [ OPTION ] /dev/sdX
   CMD:
 
 Ventoy2Disk.sh CMD [ OPTION ] /dev/sdX
   CMD:


@@ -13,16 +13,53 @@ Ventoy2Disk.sh CMD [ OPTION ] /dev/sdX
    -r SIZE_MB  preserve some space at the bottom of the disk (only for install)
    -s          enable secure boot support (default is disabled)
    -g          use GPT partition style, default is MBR style (only for install)
    -r SIZE_MB  preserve some space at the bottom of the disk (only for install)
    -s          enable secure boot support (default is disabled)
    -g          use GPT partition style, default is MBR style (only for install)

-   
+
+Please refer https://www.ventoy.net/en/doc_start.html for details.   
+
+
+========== VentoyWeb.sh ===============
+1. sudo bash VentoyWeb.sh 
+2. open your browser and visit http://127.0.0.1:24680
+
+
+========== VentoyPlugson.sh ===============
+1. sudo bash VentoyPlugson.sh /dev/sdX
+2. open your browser and visit http://127.0.0.1:24681
+
+========== VentoyVlnk.sh ===============
+Usage:  sudo bash VentoyVlnk.sh CMD FILE
+  CMD:
+   -c FILE      create vlnk for FILE
+   -l VLNK      parse vlnk file
+   -v           print verbose info
+   -h           print this help
+
+
+========= VentoyGUI ===================
+VentoyGUI is native GUI program for Linux (GTK/QT)
+1. Just double-click the file (e.g. VentoyGUI.x86_64)
+2. If it can not startup after double-click, you can open the terminal and just execute the file (e.g.  ./VentoyGUI.x86_64)
+

 
 ========== CreatePersistentImg.sh ===============
 
 
 ========== CreatePersistentImg.sh ===============
 

-sudo sh CreatePersistentImg.sh
+sudo bash CreatePersistentImg.sh  [ -s SIZE_IN_MB ] [ -t FSTYPE ] [ -l LABEL ]   for example:
+
+bash CreatePersistentImg.sh                 ---->  persistence.dat in 1GB size and ext4 filesystem and casper-rw label
+bash CreatePersistentImg.sh -l MX-Persist   ---->  persistence.dat in 1GB size and ext4 filesystem and MX-Persist label
+bash CreatePersistentImg.sh -s 2048         ---->  persistence.dat in 2GB size and ext4 filesystem and casper-rw label
+bash CreatePersistentImg.sh -s 4096 -t xfs  ---->  persistence.dat in 4GB size and xfs  filesystem  (ext2/3/4 xfs are supported)  and casper-rw label
+
+Please refer https://www.ventoy.net/en/plugin_persistence.html for details.
+
+
+
+========== ExtendPersistentImg.sh ===============
+sudo bash ExtendPersistentImg.sh  file size   
+For example:
+bash ExtendPersistentImg.sh persistence.dat 2048  ---->  Extend persistence.dat by 2048MB
+That is to say, persistence.dat file will grow to 3GB size (assume that it is 1GB size before extend)

 
 

-sh CreatePersistentImg.sh  [ -s SIZE_IN_MB ] [ -t FSTYPE ] [ -l LABEL ]   for example:
+Please refer https://www.ventoy.net/en/plugin_persistence.html for details.

 
 

-sh CreatePersistentImg.sh                 ---->  persistence.img in 1GB size and ext4 filesystem and casper-rw label
-sh CreatePersistentImg.sh -l MX-Persist   ---->  persistence.img in 1GB size and ext4 filesystem and MX-Persist label
-sh CreatePersistentImg.sh -s 2048         ---->  persistence.img in 2GB size and ext4 filesystem and casper-rw label
-sh CreatePersistentImg.sh -s 4096 -t xfs  ---->  persistence.img in 4GB size and xfs  filesystem  (ext2/3/4 xfs are supported)  and casper-rw label