Skip to content

Commit b8fbc9f

Browse files
committed
Update installation instructions for v1.2.0
1 parent 7d05f5b commit b8fbc9f

File tree

2 files changed

+37
-34
lines changed

2 files changed

+37
-34
lines changed

modules/cli/pages/installation.adoc

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,26 @@
11
= Installation
2-
:appimage-filename: librepcb-cli-{version}-linux-x86_64.AppImage
2+
:appimage-filename: librepcb-{version}-linux-x86_64.AppImage
33
:appimage-url: {releases-url}/{appimage-filename}
4-
:bundle-filename: librepcb-cli-{version}-mac-x86_64.dmg
5-
:bundle-url: {releases-url}/{bundle-filename}
6-
:bundle-arm64-filename: librepcb-cli-{version}-mac-arm64.dmg
7-
:bundle-arm64-url: {releases-url}/{bundle-arm64-filename}
84

95
== Binary Releases
106

117
Our official LibrePCB xref:installation:index.adoc[binary releases] contain
128
the `librepcb-cli` executable next to the GUI application, so usually no
13-
separate installation is needed. But there are two exceptions: The AppImage
14-
and the macOS bundle.
15-
16-
=== Linux AppImage
17-
18-
*Download {appimage-url}[{appimage-filename}], make it executable and run it:*
9+
separate installation is needed.
1910

11+
Linux AppImage::
12+
The LibrePCB AppImage also contains the CLI, but since it's a single binary
13+
you can't run `librepcb-cli` explicitly. Instead, you have to rename the
14+
AppImage to `librepcb-cli` to make it acting as the CLI (or create a symlink):
15+
+
2016
[source,bash,subs="attributes"]
2117
----
2218
wget "{appimage-url}"
2319
chmod +x ./{appimage-filename}
24-
./{appimage-filename}
20+
mv ./{appimage-filename} ./librepcb-cli
21+
./librepcb-cli
2522
----
2623

27-
=== macOS Bundle
28-
29-
Download the portable `*.dmg` file matching your CPU architecture:
30-
31-
* *Intel (x86_64)*: {bundle-url}[{bundle-filename}]
32-
* *Apple Silicon (arm64)*: {bundle-arm64-url}[{bundle-arm64-filename}]
33-
34-
Double-click the downloaded file in Finder. Then drag and drop the app
35-
onto the "Applications" folder in Finder.
36-
3724
== Docker Image
3825

3926
The easiest way to get the LibrePCB CLI on Linux (especially for usage on CI)
Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
11
= Installation on Windows
2-
:installer-filename: librepcb-installer-{version}-windows-x86.exe
2+
:installer-filename: librepcb-installer-{version}-windows-x86_64.exe
33
:installer-url: {releases-url}/{installer-filename}
4-
:zip-filename: librepcb-{version}-windows-x86.zip
4+
:zip-filename: librepcb-{version}-windows-x86_64.zip
55
:zip-url: {releases-url}/{zip-filename}
66

7-
== Online Installer
7+
== Installer
88

9-
The recommended way to install LibrePCB is to use the online installer.
10-
It provides the following features:
11-
12-
- Installs a maintenance tool to easily download and install updates.
13-
- Creates start menu entries for LibrePCB and the maintenance tool.
14-
- Optionally registers `*.lpp` files, so LibrePCB projects can be opened
15-
with a double-click in the file manager.
9+
The recommended way to install LibrePCB is to use the installer.
1610

1711
*Just download and run {installer-url}[{installer-filename}].*
1812
Afterwards you'll find LibrePCB in your start menu.
1913

14+
[IMPORTANT]
15+
====
16+
Unfortunately we're not able yet to sign our Windows installer (it's quite
17+
expensive to do it). Therefore Windows might warn that the publisher of the
18+
installer is unknown. This is normal for binaries without paying for a
19+
signature, therefore just click on btn:[More info] and then btn:[Run anyway]
20+
to skip the warning.
21+
====
22+
23+
[NOTE]
24+
====
25+
For automated (unattended) installation, please check out the command-line
26+
parameters of the Inno Setup framework
27+
https://jrsoftware.org/ishelp/index.php?topic=setupcmdline[here]
28+
(https://jrsoftware.org/ishelp/index.php?topic=uninstcmdline[uninstall]):
29+
30+
[source,bash,subs="attributes"]
31+
----
32+
{installer-filename} /VERYSILENT /SUPPRESSMSGBOXES
33+
----
34+
====
35+
2036
== Portable Package
2137

2238
Alternatively you could run LibrePCB without installing it. But then you don't
23-
get an update mechanism, no start menu entries are created, and `*.lpp` files
24-
will not be registered.
39+
get start menu entries and LibrePCB file extensions won't be registered so
40+
you can't open LibrePCB projects with a double-click in the file manager.
2541

2642
Download and extract {zip-url}[{zip-filename}], then run the contained file
2743
`bin\librepcb.exe`.

0 commit comments

Comments
 (0)