Skip to content
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

Update to LibrePCB 1.2.0 #77

Merged
merged 3 commits into from
Dec 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
37 changes: 16 additions & 21 deletions modules/cli/pages/installation.adoc
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
11 changes: 10 additions & 1 deletion modules/installation/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
40 changes: 28 additions & 12 deletions modules/installation/pages/windows.adoc
Original file line number Diff line number Diff line change
@@ -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`.