From 7d05f5b7e30c5ac26ba4abd2e1425508f24b33e9 Mon Sep 17 00:00:00 2001 From: "U. Bruhin" Date: Sat, 30 Nov 2024 00:02:06 +0100 Subject: [PATCH 1/3] Update download links to LibrePCB 1.2.0 --- antora-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/antora-playbook.yml b/antora-playbook.yml index fc7c775..f0cae16 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -15,7 +15,7 @@ asciidoc: page-pagination: '' table-frame: 'none@' table-grid: 'rows@' - version: '1.1.0' # <-- Latest LibrePCB version. + version: '1.2.0' # <-- Latest LibrePCB version. ui: bundle: url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable From 54777c004f61b13994c1e8184138eb6e6a3813bc Mon Sep 17 00:00:00 2001 From: "U. Bruhin" Date: Sat, 30 Nov 2024 00:02:30 +0100 Subject: [PATCH 2/3] Update installation instructions for v1.2.0 --- modules/cli/pages/installation.adoc | 37 ++++++++++------------- modules/installation/pages/windows.adoc | 40 +++++++++++++++++-------- 2 files changed, 44 insertions(+), 33 deletions(-) diff --git a/modules/cli/pages/installation.adoc b/modules/cli/pages/installation.adoc index 985d03c..f4f4e46 100644 --- a/modules/cli/pages/installation.adoc +++ b/modules/cli/pages/installation.adoc @@ -1,39 +1,34 @@ = Installation -:appimage-filename: librepcb-cli-{version}-linux-x86_64.AppImage +:appimage-filename: librepcb-{version}-linux-x86_64.AppImage :appimage-url: {releases-url}/{appimage-filename} -:bundle-filename: librepcb-cli-{version}-mac-x86_64.dmg -:bundle-url: {releases-url}/{bundle-filename} -:bundle-arm64-filename: librepcb-cli-{version}-mac-arm64.dmg -:bundle-arm64-url: {releases-url}/{bundle-arm64-filename} == Binary Releases Our official LibrePCB xref:installation:index.adoc[binary releases] contain the `librepcb-cli` executable next to the GUI application, so usually no -separate installation is needed. But there are two exceptions: The AppImage -and the macOS bundle. +separate installation is needed. -=== Linux AppImage - -*Download {appimage-url}[{appimage-filename}], make it executable and run it:* +MacOS:: + You need to invoke the CLI with the full path to the binary: ++ +[source,bash] +---- +/Applications/LibrePCB.app/Contents/MacOS/librepcb-cli --help +---- +Linux AppImage:: + The LibrePCB AppImage also contains the CLI, but since it's a single binary + you can't run `librepcb-cli` explicitly. Instead, you have to rename the + AppImage to `librepcb-cli` to make it acting as the CLI (or create a symlink): ++ [source,bash,subs="attributes"] ---- wget "{appimage-url}" chmod +x ./{appimage-filename} -./{appimage-filename} +mv ./{appimage-filename} ./librepcb-cli +./librepcb-cli --help ---- -=== macOS Bundle - -Download the portable `*.dmg` file matching your CPU architecture: - -* *Intel (x86_64)*: {bundle-url}[{bundle-filename}] -* *Apple Silicon (arm64)*: {bundle-arm64-url}[{bundle-arm64-filename}] - -Double-click the downloaded file in Finder. Then drag and drop the app -onto the "Applications" folder in Finder. - == Docker Image The easiest way to get the LibrePCB CLI on Linux (especially for usage on CI) diff --git a/modules/installation/pages/windows.adoc b/modules/installation/pages/windows.adoc index 27bc12c..434103a 100644 --- a/modules/installation/pages/windows.adoc +++ b/modules/installation/pages/windows.adoc @@ -1,27 +1,43 @@ = Installation on Windows -:installer-filename: librepcb-installer-{version}-windows-x86.exe +:installer-filename: librepcb-installer-{version}-windows-x86_64.exe :installer-url: {releases-url}/{installer-filename} -:zip-filename: librepcb-{version}-windows-x86.zip +:zip-filename: librepcb-{version}-windows-x86_64.zip :zip-url: {releases-url}/{zip-filename} -== Online Installer +== Installer -The recommended way to install LibrePCB is to use the online installer. -It provides the following features: - -- Installs a maintenance tool to easily download and install updates. -- Creates start menu entries for LibrePCB and the maintenance tool. -- Optionally registers `*.lpp` files, so LibrePCB projects can be opened - with a double-click in the file manager. +The recommended way to install LibrePCB is to use the installer. *Just download and run {installer-url}[{installer-filename}].* Afterwards you'll find LibrePCB in your start menu. +[IMPORTANT] +==== +Unfortunately we're not able yet to sign our Windows installer (it's quite +expensive to do it). Therefore Windows might warn that the publisher of the +installer is unknown. This is normal for binaries without paying for a +signature, therefore just click on btn:[More info] and then btn:[Run anyway] +to skip the warning. +==== + +[NOTE] +==== +For automated (unattended) installation, please check out the command-line +parameters of the Inno Setup framework +https://jrsoftware.org/ishelp/index.php?topic=setupcmdline[here] +(https://jrsoftware.org/ishelp/index.php?topic=uninstcmdline[uninstall]): + +[source,bash,subs="attributes"] +---- +{installer-filename} /VERYSILENT /SUPPRESSMSGBOXES +---- +==== + == Portable Package Alternatively you could run LibrePCB without installing it. But then you don't -get an update mechanism, no start menu entries are created, and `*.lpp` files -will not be registered. +get start menu entries and LibrePCB file extensions won't be registered so +you can't open LibrePCB projects with a double-click in the file manager. Download and extract {zip-url}[{zip-filename}], then run the contained file `bin\librepcb.exe`. From aad1c73519d15c940680134c8cb2e5c078edb43f Mon Sep 17 00:00:00 2001 From: "U. Bruhin" Date: Sun, 1 Dec 2024 12:11:16 +0100 Subject: [PATCH 3/3] Installation: Add link to Chocolatey package --- modules/installation/pages/index.adoc | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/modules/installation/pages/index.adoc b/modules/installation/pages/index.adoc index 7c336d4..061bf22 100644 --- a/modules/installation/pages/index.adoc +++ b/modules/installation/pages/index.adoc @@ -19,14 +19,23 @@ For other systems, a LibrePCB package might be provided by a package maintainer, either partially related or unrelated to the LibrePCB developers. We are aware of the following packages: +* link:https://community.chocolatey.org/packages/librepcb[Chocolatey Package] + (Windows) +* link:https://formulae.brew.sh/cask/librepcb[Homebrew Cask Package] + (MacOS) * link:https://aur.archlinux.org/packages/librepcb[Arch Linux AUR Package] (builds from source) * link:https://search.nixos.org/packages?channel=unstable&show=librepcb&from=0&size=50&type=packages&query=librepcb[NixOS Package] * link:https://packages.gentoo.org/packages/sci-electronics/librepcb[Gentoo Package] -* link:https://formulae.brew.sh/cask/librepcb[Homebrew Cask Package] * link:https://repo.openpandora.org/?page=detail&app=librepcb[OpenPandora Package] * link:https://voidlinux.org/packages/?arch=x86_64&q=librepcb[Void Linux Package] +[WARNING] +==== +As these packages are not under our control, we cannot guarantee their +genuineness and correctness. +==== + [TIP] ==== You're a LibrePCB package maintainer?