-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Format cleanup #66
base: master
Are you sure you want to change the base?
Format cleanup #66
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. better place link on text There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I mean, link embedded in text would be more readable in this case FYI for GFMD angle brackets aren't needed: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#urls |
||
|
||
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> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. not clear why the angle brackets are needed There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
# **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> | ||
CvH marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 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` | ||
|
||
|
@@ -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,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 | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
#!/bin/sh | ||
|
||
sudo add-apt-repository universe -y | ||
sudo apt update -y | ||
sudo apt install -y cmake \ | ||
sudo apt-get update -y -qq | ||
sudo apt-get install -y -qq cmake \ | ||
gcc \ | ||
g++ \ | ||
libgl1-mesa-dev \ | ||
qt6-base-dev \ | ||
qt6-l10n-tools \ | ||
qt6-tools-dev \ | ||
qt6-tools-dev-tools \ | ||
qt6-wayland-dev \ | ||
qt6-wayland-dev | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added the backslash intentionally :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what does this achieve ? from bash perspective its just adding a useless space character at the end of the command There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. if you add another line (package) below this one in the future, you won't have to modify this line. JSON format from such issue for example - you can't add comma after last element in object/array. |
||
|
||
echo "CC=gcc" >> $GITHUB_ENV | ||
echo "CXX=g++" >> $GITHUB_ENV | ||
echo "CC=gcc" >>$GITHUB_ENV | ||
echo "CXX=g++" >>$GITHUB_ENV |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess quotes can be omitted completely
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes/no, it will likely work without quotes too but in general quotes are wanted - also shown at the official GHA examples etc so won't hurt doing proper gha/yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
well, we don't use them in other places. Either they should be used everywhere or nowhere at all.