[misc] convert README file to MarkDown

* Closes #539
This commit is contained in:
Jaka Smrekar 2015-06-24 00:05:05 +02:00 committed by Pete Batard
parent cc6234296d
commit c8cefb4f2a
3 changed files with 56 additions and 54 deletions

48
README.md Normal file
View File

@ -0,0 +1,48 @@
# Rufus: The Reliable USB Formatting Utility
## Features
* Formats USB and Virtual HD drives to FAT/FAT32/NTFS/UDF/exFAT/ReFS
* Creates DOS bootable USB drives, using [FreeDOS](http://www.freedos.org/) or MS-DOS
* Creates BIOS or UEFI bootable drives, including UEFI bootable NTFS
* Creates bootable drives from bootable ISOs (Windows, Linux, etc.)
* Creates bootbale drives from bootable disk images, including compressed ones
* Creates [Windows To Go](https://en.wikipedia.org/wiki/Windows_To_Go) drives
* Twice as fast as Microsoft's USB/DVD tool or UNetbootin, on ISO -> USB (1)
* Performs bad blocks checks, including fake drives detection
* Modern and familiar UI, with more than [30 languages natively supported](http://rufus.akeo.ie/translations)
* Small footprint with no installation required
* 100% Free Software (GPL v3)
## Compilation
Use either Visual Studio 2013, WDK 7.1 (Windows Driver Kit) or MinGW and then
invoke the `.sln`, `wdk_build.cmd` or `configure`/`make` respectively.
#### Visual Studio
Note that, since Rufus is an OSI compliant Open Source project, you are entitled to
download and use the *freely available* [Visual Studio 2013 Community Edition]
(http://www.visualstudio.com/products/visual-studio-community-vs) to
build, run or develop for Rufus. As per the Visual Studio Community Edition license
this applies regardless of whether you are an individual or a corporate user.
For details, see [this](http://pete.akeo.ie/2014/11/visual-studio-2013-has-now-become.html).
## Additional information
Rufus provides extensive information about what it is doing, either through
its easily accessible log, or through the Windows debug facility.
For more info, please consult:
* The Official Website - http://rufus.akeo.ie
* The Official FAQ - http://rufus.akeo.ie/FAQ
## Enhancements/Bugs
Please use the [GitHub issue tracker](https://github.com/pbatard/rufus/issues)
for reporting problems or suggesting new features.
(1) Tests carried out with a 16 GB USB 3.0 ADATA pen drive on a Core 2 duo/4 GB RAM platform running Windows 7 x64.
ISO: `en_windows_7_ultimate_with_sp1_x64_dvd_618240.iso`
| Name of tool | Version | Time |
| ------------ | ------- | ---- |
| [Windows USB/DVD Download Tool](http://www.microsoft.com/en-us/download/windows-usb-dvd-download-tool) | v1.0.30 | 8 mins 10s |
| [UNetbootin](http://unetbootin.sourceforge.net) | v1.1.1.1 | 6 mins 20s |
| **Rufus** | v1.1.0 | **3 mins 25s** |

View File

@ -1,46 +0,0 @@
Rufus: The Reliable USB Formatting Utility
Features:
- Formats USB flash drives as well as VHD images to FAT/FAT32/NTFS/UDF/exFAT/ReFS
- Creates DOS bootable USB drives, using FreeDOS or MS-DOS with no external files required
- Creates MBR or GPT/UEFI bootable drives, including UEFI bootable NTFS
- Creates bootable drives from bootable ISOs (Windows, Linux, etc.)
- Creates bootbale drives from disk images, including compressed ones
- Creates Windows To Go drives
- Twice as fast as Microsoft's USB/DVD tool or UNetbootin, on ISO->USB (1)
- Can perform bad blocks check, with fake drive detection
- Modern and familiar UI, with more than 30 languages natively supported (2)
- Small footprint, no installation required
- 100% Free Software (GPL v3)
Compilation:
Use either Visual Studio 2013, WDK 7.1 (Windows Driver Kit) or MinGW and then
invoke the .sln, wdk_build.cmd or configure/make respectively.
Note that, since Rufus is an OSI compliant Open Source project, you are entitled to
download and use the *freely available* Visual Studio 2013 Community Edition to
build, run or develop for Rufus. As per the Visual Studio Community Edition license
this applies regardless of whether you are an individual or a corporate user.
For details, see http://www.visualstudio.com/products/visual-studio-community-vs
or http://pete.akeo.ie/2014/11/visual-studio-2013-has-now-become.html
Additional information:
Rufus provides extensive information about what it is doing, either through
its easily accessible log, or through the Windows debug facility.
More info:
http://rufus.akeo.ie
http://rufus.akeo.ie/FAQ
Enhancements/Bugs
https://github.com/pbatard/rufus/issues
(1) Tests carried out with a 16 GB USB 3.0 ADATA pen drive on a
Core 2 duo/4 GB RAM platform running Windows 7 x64.
ISO: en_windows_7_ultimate_with_sp1_x64_dvd_618240.iso
- Windows 7 USB/DVD Download Tool v1.0.30: 8 mins 10s
- UNetbootin v1.1.1.1: 6 mins 20s
- Rufus v1.1.0: 3 mins 25s
(2) http://rufus.akeo.ie/translations

View File

@ -32,7 +32,7 @@ LANGUAGE LANG_NEUTRAL, SUBLANG_NEUTRAL
IDD_DIALOG DIALOGEX 12, 12, 242, 376
STYLE DS_SETFONT | DS_MODALFRAME | DS_CENTER | WS_MINIMIZEBOX | WS_POPUP | WS_CAPTION | WS_SYSMENU
CAPTION "Rufus 2.3.679"
CAPTION "Rufus 2.3.680"
FONT 8, "Segoe UI", 400, 0, 0x1
BEGIN
LTEXT "Device",IDS_DEVICE_TXT,9,6,200,8
@ -157,7 +157,7 @@ END
IDD_DIALOG_XP DIALOGEX 12, 12, 242, 376
STYLE DS_SETFONT | DS_MODALFRAME | DS_CENTER | WS_MINIMIZEBOX | WS_POPUP | WS_CAPTION | WS_SYSMENU
CAPTION "Rufus 2.3.679"
CAPTION "Rufus 2.3.680"
FONT 8, "MS Shell Dlg", 400, 0, 0x1
BEGIN
LTEXT "Device",IDS_DEVICE_TXT,9,6,200,8
@ -283,7 +283,7 @@ END
IDD_DIALOG_RTL DIALOGEX 12, 12, 242, 376
STYLE DS_SETFONT | DS_MODALFRAME | DS_CENTER | WS_MINIMIZEBOX | WS_POPUP | WS_CAPTION | WS_SYSMENU
EXSTYLE WS_EX_RTLREADING | WS_EX_APPWINDOW | WS_EX_LAYOUTRTL
CAPTION "Rufus 2.3.679"
CAPTION "Rufus 2.3.680"
FONT 8, "Segoe UI", 400, 0, 0x1
BEGIN
LTEXT "Device",IDS_DEVICE_TXT,9,6,200,8
@ -415,7 +415,7 @@ END
IDD_DIALOG_RTL_XP DIALOGEX 12, 12, 242, 376
STYLE DS_SETFONT | DS_MODALFRAME | DS_CENTER | WS_MINIMIZEBOX | WS_POPUP | WS_CAPTION | WS_SYSMENU
EXSTYLE WS_EX_RTLREADING | WS_EX_APPWINDOW | WS_EX_LAYOUTRTL
CAPTION "Rufus 2.3.679"
CAPTION "Rufus 2.3.680"
FONT 8, "MS Shell Dlg", 400, 0, 0x1
BEGIN
LTEXT "Device",IDS_DEVICE_TXT,9,6,200,8
@ -671,8 +671,8 @@ END
//
VS_VERSION_INFO VERSIONINFO
FILEVERSION 2,3,679,0
PRODUCTVERSION 2,3,679,0
FILEVERSION 2,3,680,0
PRODUCTVERSION 2,3,680,0
FILEFLAGSMASK 0x3fL
#ifdef _DEBUG
FILEFLAGS 0x1L
@ -689,13 +689,13 @@ BEGIN
BEGIN
VALUE "CompanyName", "Akeo Consulting (http://akeo.ie)"
VALUE "FileDescription", "Rufus"
VALUE "FileVersion", "2.3.679"
VALUE "FileVersion", "2.3.680"
VALUE "InternalName", "Rufus"
VALUE "LegalCopyright", "© 2011-2015 Pete Batard (GPL v3)"
VALUE "LegalTrademarks", "http://www.gnu.org/copyleft/gpl.html"
VALUE "OriginalFilename", "rufus.exe"
VALUE "ProductName", "Rufus"
VALUE "ProductVersion", "2.3.679"
VALUE "ProductVersion", "2.3.680"
END
END
BLOCK "VarFileInfo"