Skip to content

Commit

Permalink
markdown format fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
CvH committed Feb 27, 2024
1 parent 182e109 commit 7e9f79e
Showing 1 changed file with 30 additions and 21 deletions.
51 changes: 30 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <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.

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: <https://forum.libreelec.tv/board/41-usb-sd-creator-support>

# **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

<https://www.7-zip.org/download.html>

### 3. Install Git
https://git-scm.com/download/win

<https://git-scm.com/download/win>

### 4. Install Ruby
https://rubyinstaller.org/downloads/ select "WITHOUT DEVKIT" for download

<https://rubyinstaller.org/downloads/> 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
<https://www.activestate.com/products/perl/> (needs registration) or

<https://www.softpedia.com/get/Programming/Coding-languages-Compilers/ActivePerl.shtml>

### 6. Install Python
https://www.python.org/downloads/windows/ select Windows installer (64-bit) for download

<https://www.python.org/downloads/windows/> 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`

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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
```

Expand All @@ -124,14 +132,15 @@ 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
```

**Or:**

Run the app from the command line using sudo

```
```shell
sudo ./LibreELEC\ USB-SD\ Creator.app/Contents/MacOS/LibreELEC\ USB-SD\ Creator
```

0 comments on commit 7e9f79e

Please sign in to comment.