From 7e9f79eb8404d78b9964b9aa19a13147aa3a614e Mon Sep 17 00:00:00 2001 From: CvH <1355173+CvH@users.noreply.github.com> Date: Tue, 27 Feb 2024 18:38:06 +0100 Subject: [PATCH] markdown format fixes --- README.md | 51 ++++++++++++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index ba113d3..1eb67c6 100644 --- a/README.md +++ b/README.md @@ -4,58 +4,66 @@ This is a lightweight image writing app with a simple four-step GUI for creating ## Translation Changes -Changes to master language (en_GB) strings can be submitted via pull request to this GitHub repo. English strings are periodically synchronised to a Transifex project: https://www.transifex.com/libreelec/libreelec-usb-sd-creator allowing contributors to translate them into other languages. Translated strings are periodically synchronised from Transifex back to this repo for inclusion in the next release. +Changes to master language (en_GB) strings can be submitted via pull request to this GitHub repo. English strings are periodically synchronised to a Transifex project: allowing contributors to translate them into other languages. Translated strings are periodically synchronised from Transifex back to this repo for inclusion in the next release. Pull requests for all other languages will be rejected. You will be asked to submit changes via Transifex. ## Translation Languages -Requests for new languages should be made on Transifex. Once a new language has been approved it will be added to the translation project where you can conribute translated strings. +Requests for new languages should be made on Transifex. Once a new language has been approved it will be added to the translation project where you can contribute translated strings. Please note: languages are translated by people (you) not magic! ## Issues and Support -Issues should be reported via the forum here: https://forum.libreelec.tv/board/41-usb-sd-creator-support +Issues should be reported via the forum here: # **How to compile the USB/SD Creator** -# Windows +## Windows ### 1. install "Qt Online Installer" + select: Custom install -> select QT 6.6.2 -> disable all besides MinGW Install to `C:\QT` ### 2. Install 7zip -https://www.7-zip.org/download.html + + ### 3. Install Git -https://git-scm.com/download/win + + ### 4. Install Ruby -https://rubyinstaller.org/downloads/ select "WITHOUT DEVKIT" for download + + select "WITHOUT DEVKIT" for download ### 5. Install Perl -https://www.activestate.com/products/perl/ (needs registration) or -https://www.softpedia.com/get/Programming/Coding-languages-Compilers/ActivePerl.shtml + (needs registration) or + + ### 6. Install Python -https://www.python.org/downloads/windows/ select Windows installer (64-bit) for download + + select Windows installer (64-bit) for download at install select "Add Python to PATH" ### 7. Add programs to PATH variable -`C:\Qt\Tools\Ninja` +`C:\Qt\Tools\Ninja` `C:\Qt\Tools\CMake_64\bin` reboot Windows ### 8. Clone Git Repo -Clone the repository to `C:\usb-sd-creator` + +Clone the repository to `C:\usb-sd-creator` `git clone https://github.com/LibreELEC/usb-sd-creator.git` ### 9. Enable powershell script execution + Open cmd with admin rights `powershell Set-ExecutionPolicy RemoteSigned` @@ -69,12 +77,11 @@ Open powershell at C:\usb-sd-creator After the compiling is finished the files are located at `C:\Qt\static\$version` . ### 11. Build USB-SD-Creator -Open a cmd at `C:\usb-sd-creator` and run `windows_build.bat`. -The finished executable is located at `C:\usb-sd-creator\releases`. -# MacOS +Open a cmd at `C:\usb-sd-creator` and run `windows_build.bat`. +The finished executable is located at `C:\usb-sd-creator\releases`. -### Building for MacOS +## MacOS ### 1. Install XCode with Command-line tools @@ -84,7 +91,7 @@ The finished executable is located at `C:\usb-sd-creator\releases`. Open a command prompt and type the following in the console: -``` +```shell mkdir -p ~/Downloads ~/Qt cd ~/Downloads @@ -104,14 +111,15 @@ TODO Assuming the repo is in your home directory -``` +```shell cd ~/usb-sd-creator ./osx_build.sh ``` If building again cleanup using: -``` + +```shell ./osx_clean.sh ``` @@ -124,7 +132,8 @@ Simply double click the app from a finder window in the root of the repo: `Libre #### Command line Run the app from the command line, that will prompt for a password: -``` + +```shell ./LibreELEC\ USB-SD\ Creator.app/Contents/MacOS/LibreELEC\ USB-SD\ Creator ``` @@ -132,6 +141,6 @@ Run the app from the command line, that will prompt for a password: Run the app from the command line using sudo -``` +```shell sudo ./LibreELEC\ USB-SD\ Creator.app/Contents/MacOS/LibreELEC\ USB-SD\ Creator ```