Skip to content

Update BUILD instructions #500

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update BUILD instructions #500

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can download the source either using Git or by mannually downloading a tarba
The branch can be customized by setting the `-b` or `--branch` argument. Select `stable` to download the current stable source or use `master` to get the most current unstable source containing the latest features.

```shell
git clone https://github.com/TheAssassin/AppImageLauncher.git -b stable
git clone https://github.com/TheAssassin/AppImageLauncher.git -b master
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using master is not a universal solution to every problem. Yes, the branch is fairly stable. stable however points to the latest release, which is always preferable for users.

The actual issue is that I have not got to making another release in a long time... The next release will be 3.0.0, but there is quite some work left.

You could mention master as an alternative, something like "if stable is broken, please git checkout master and try again" might do.

cd AppImageLauncher
git submodule update --init --recursive
```
Expand Down Expand Up @@ -55,8 +55,8 @@ make

Now you may create a distribution package or alternatively install the source for testing purpose.

*Note: This may harm your system. It's highly recommended to build and install distribution packages instead.*
Directly running `make install` will carry a high risk of breaking your system, so it's suggested that you use `checkinstall` instead. Install `checkinstall` with your system's package manager, and then run the installation via checkinstall.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

checkinstall has zero advantage over using CMake's CPack to generate a .deb or .rpm, but has multiple disadvantages. checkinstall is pretty much a workaround used when there is no alternative. It can break your system, too, and does not provide universal packages which work on other computers as well. AppImageLauncher has a tested CPack configuration which is also used for the officially released packages.

Compared to checkinstall, CPack does not require root access, does not actually write files on your system and does not depend on just comparing the file trees before and after make install, making it a more reliable and less invasive solution. Additionally, CPack is aware of the so-called maintainer scripts which perform some post-install tasks and post-removal cleanup.

My suggestion is to have people run CPack themselves to generate packages if those are needed.


```shell
sudo make install
sudo checkinstall
```