Added some notes on the appimages into the install doc
This commit is contained in:
parent
638b5a9b1a
commit
8280e058c7
31
INSTALL.md
31
INSTALL.md
|
@ -7,6 +7,37 @@
|
|||
- Source
|
||||
`git clone git://github.com/Bitmessage/PyBitmessage.git`
|
||||
|
||||
## Notes on the AppImages
|
||||
|
||||
The [AppImage](https://docs.appimage.org/introduction/index.html)
|
||||
is a bundle, built by the
|
||||
[appimage-builder](https://github.com/AppImageCrafters/appimage-builder) from
|
||||
the Ubuntu Bionic deb files, the sources and `bitmsghash.so`, precompiled for
|
||||
3 architectures, using the `packages/AppImage/AppImageBuilder.yml` recipe.
|
||||
|
||||
When you run the appimage the bundle is loop mounted to a location like
|
||||
`/tmp/.mount_PyBitm97wj4K` with `squashfs-tools`.
|
||||
|
||||
The appimage name has several informational filds:
|
||||
```
|
||||
PyBitmessage-<VERSION>-g<COMMITHASH>[-alpha]-<ARCH>.AppImage
|
||||
```
|
||||
|
||||
E.g. `PyBitmessage-0.6.3.2-ge571ba8a-x86_64.AppImage` is an appimage, built from
|
||||
the `v0.6` for x86_64 and `PyBitmessage-0.6.3.2-g9de2aaf1-alpha-aarch64.AppImage`
|
||||
is one, built from some development branch for arm64.
|
||||
|
||||
You can also build the appimage with local code. For that you need installed
|
||||
docker:
|
||||
|
||||
```
|
||||
$ docker build -t bm-appimage -f .buildbot/appimage/Dockerfile .
|
||||
$ docker run -t --rm -v "$(pwd)"/dist:/out bm-appimage .buildbot/appimage/build.sh
|
||||
```
|
||||
|
||||
The appimages should be in the dist dir.
|
||||
|
||||
|
||||
## Helper Script for building from source
|
||||
Go to the directory with PyBitmessage source code and run:
|
||||
```
|
||||
|
|
Reference in New Issue
Block a user