diff options
| author | Felix (xq) Queißner <git@mq32.de> | 2020-06-19 21:29:27 +0200 |
|---|---|---|
| committer | Felix (xq) Queißner <git@mq32.de> | 2020-06-19 21:29:27 +0200 |
| commit | 51edb67505ffc536d748b26b78d87885bfa5f66e (patch) | |
| tree | 3bad68db363e21a8c511e11a419cfe61c438be3d | |
| parent | 4ae3a4e3cdcbffb77b4a329c70e6e8071cb4b161 (diff) | |
| download | kristall-51edb67505ffc536d748b26b78d87885bfa5f66e.tar.gz | |
Removes windows and ubuntu 16.04 from CI, moves build instructions into own file.
| -rw-r--r-- | .github/workflows/build.yml | 16 | ||||
| -rw-r--r-- | BUILDING.md | 94 | ||||
| -rw-r--r-- | README.md | 87 |
3 files changed, 95 insertions, 102 deletions
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 497ae7e..b3d6210 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,19 +21,3 @@ jobs: - uses: jurplel/install-qt-action@v2 - name: make run: make - build_ubuntu_16: - runs-on: ubuntu-16.04 - steps: - - uses: actions/checkout@v2 - - uses: jurplel/install-qt-action@v2 - - name: make - run: make - build_windows: - runs-on: windows-latest - steps: - - uses: actions/checkout@v2 - - uses: jurplel/install-qt-action@v2 - - name: vcvars - run: call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat" - - name: make - run: make diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 0000000..b98b6b2 --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,94 @@ +# Building + +Here you can find build instructions for Kristall. + +## Requirements + +- Latest Qt5 version with `widgets` and `network` modules + +## Build + +### *nix + +There's a small `Makefile` provided that does all necessary steps and creates a build directory, then copies the build artifact from the build directory. Just do `make` in the root directory, it should work. + +Or you can use the usual Qt5 build process: + +```sh +mkdir build +cd build +qmake ../src/kristall.pro +make +``` + +#### Notes for OpenBSD +- It seems like Qt wants `libzstd.so.3.1` instead of `libzstd.so.3.2`. Just symlink that file into the build directory +- Use `make` and not `gmake` to build the project. + +#### Notes for Ubuntu +Supported Versions: 18.04, 20.04 +Unsupported Versions: 16.04 + +- Required packages + - `qt5-default` + - `qt5-qmake` + - `qtmultimedia5-dev` + - `libqt5svg5-dev` + - `libssl-dev` + - `make` + - `g++` + +These notes are probably also correct for Debian (someone please verify) + +#### Notes for Manjaro/Arch +- Required packages + - `qt5` + - `qt5-multimedia` + - `openssl` or `libressl` + +#### Notes on void linux +- set env variable `QT_SELECT=5` + +#### Windows + +Compile OpenSSL with the following steps: +- Install [Perl](https://www.perl.org/get.html) (either ActiveState or Strawberry) +- Install [NASM](https://www.nasm.us/) +- Add both to your PATH +- Clone [OpenSSL](https://github.com/openssl/openssl) +- Open a Visual Studio Developer Command Prompt (or a command prompt that has ran vcvarsall.bat). You will need Administrator privileges for the install step +- In the OpenSSL root directory, run `perl Configure VC-WIN32` if compiling for 32 bit, `perl Configure VC-WIN64A` for 64 bit +- Run `nmake` +- Run `nmake install` to install OpenSSL in `C:\Program Files\OpenSSL` + +Use QtCreator to build `./src/kristall.pro` with default settings. + +#### MacOS X + +Use the `Makefile` to build `build/kristall` instead of the default target. There is currently no auto-recognition of MacOS (where qmake will output a `kristall.app` file), so you have to be a bit more manual. + +#### Haiku + +1. Install the following packages with `pkgman`: + - `qt5` + - `qt5_devel` + - `qt5_tools` +2. Use `make` to build th executable + +## Manual Installation + +### Unix / XDG + +The provided desktop file can be installed into the local system +```sh +ln -s Kristall.desktop ~/.local/share/applications/kristall.desktop +``` + +### Haiku + +Link the `kristall` executable to your applications menu: + +```sh +cd ~/config/settings/deskbar/menu/Applications/ +ln -s /path/to/kristall . +```
\ No newline at end of file @@ -49,92 +49,7 @@ A high-quality visual cross-platform gemini browser. ## Build/Install Instructions -### Requirements - -- Latest Qt5 version with `widgets` and `network` modules - -### Build - -#### *nix - -There's a small `Makefile` provided that does all necessary steps and creates a build directory, then copies the build artifact from the build directory. Just do `make` in the root directory, it should work. - -Or you can use the usual Qt5 build process: - -```sh -mkdir build -cd build -qmake ../src/kristall.pro -make -``` - -### Notes for OpenBSD -- It seems like Qt wants `libzstd.so.3.1` instead of `libzstd.so.3.2`. Just symlink that file into the build directory -- Use `make` and not `gmake` to build the project. - -##### Notes for Ubuntu 20.04 / Linux Mint: -- Requires packages - - `qt5-default` - - `qt5-qmake` - - `qtmultimedia5-dev` - - `libqt5svg5-dev` - - `libssl-dev` - - `make` - - `g++` - -These notes are probably also correct for Debian (someone please verify) - -##### Notes for Manjaro/Arch -- Requires packages - - `qt5` - - `qt5-multimedia` - -##### Notes on void linux -- set env variable `QT_SELECT=5` - -#### Windows - -Compile OpenSSL with the following steps: -- Install [Perl](https://www.perl.org/get.html) (either ActiveState or Strawberry) -- Install [NASM](https://www.nasm.us/) -- Add both to your PATH -- Clone [OpenSSL](https://github.com/openssl/openssl) -- Open a Visual Studio Developer Command Prompt (or a command prompt that has ran vcvarsall.bat). You will need Administrator privileges for the install step -- In the OpenSSL root directory, run `perl Configure VC-WIN32` if compiling for 32 bit, `perl Configure VC-WIN64A` for 64 bit -- Run `nmake` -- Run `nmake install` to install OpenSSL in `C:\Program Files\OpenSSL` - -Use QtCreator to build `./src/kristall.pro` with default settings. - -#### MacOS X - -Use the `Makefile` to build `build/kristall` instead of the default target. There is currently no auto-recognition of MacOS (where qmake will output a `kristall.app` file), so you have to be a bit more manual. - -#### Haiku - -1. Install the following packages with `pkgman`: - - `qt5` - - `qt5_devel` - - `qt5_tools` -2. Use `make` to build th executable - -### Manual Installation - -#### Unix / XDG - -The provided desktop file can be installed into the local system -```sh -ln -s Kristall.desktop ~/.local/share/applications/kristall.desktop -``` - -#### Haiku - -Link the `kristall` executable to your applications menu: - -```sh -cd ~/config/settings/deskbar/menu/Applications/ -ln -s /path/to/kristall . -``` +See [BUILDING.md](BUILDING.md) ## Credits |
