|
1 | | -# Linux build instructions for Tau5 |
2 | | - |
3 | | -## Install Deps |
4 | | - |
5 | | -Tau5 is known to work with the following depencies: |
6 | | - |
7 | | -1. gcc or clang |
8 | | -2. Qt6 (see Qt Version Requirements below) |
9 | | -3. CMake (3.30+) |
10 | | -4. Elixir(1.17+) |
11 | | - |
12 | | -To install dependencies: |
13 | | -- For full GUI build: `./bin/linux/install-gui-deps.sh` |
14 | | -- For headless/node only: `./bin/linux/install-node-deps.sh` |
15 | | - |
16 | | -Both scripts cover Debian, Redhat, Arch and OpenSuse based distributions. |
17 | | - |
18 | | -**Note, that you'll need to use `sudo` so like all other scripts that requre `sudo` that you didn't write yourself - definitely look through the file first to make sure you're happy.** |
19 | | - |
20 | | -Once the dependencies are installed double check that your version of Elixir is recent enough. Unfortunately most linux distros don't yet ship with a sufficiently recent version of Elixir. If this is the case for you, you might want to try using [asdf](https://github.com/asdf-vm/asdf). |
21 | | - |
22 | | -### Qt Version Requirements |
23 | | - |
24 | | -**For tau5-gui (full GUI build):** |
25 | | -- Minimum: Qt 6.6.0 |
26 | | -- Maximum tested: Qt 6.9.1 |
27 | | -- Recommended: Qt 6.9.1 (used in CI for all GUI builds) |
28 | | - |
29 | | -**For tau5-node (headless/node only):** |
30 | | -- Minimum: Qt 6.2.4 (available in Ubuntu 22.04 LTS repositories) |
31 | | -- Maximum tested: Qt 6.9.1 |
32 | | - |
33 | | -**Important Notes:** |
34 | | -- Ubuntu 22.04 LTS system packages provide Qt 6.2.4, which is only sufficient for tau5-node builds |
35 | | -- For GUI builds on Ubuntu 22.04, you must install Qt 6.6.0 or later from qt.io or use the install scripts |
36 | | - |
37 | | - |
38 | | - |
39 | | - |
40 | | - |
41 | | -## Fetch Tau5 |
42 | | - |
43 | | -Find a nice directory to put Tau5 in. I typically use `~/Develolopment`. Change into it and clone the Tau5 github repository: |
44 | | - |
45 | | -``` |
46 | | -cd ~/Development |
47 | | -git clone https://github.com/samaaron/tau5 |
48 | | -``` |
49 | | - |
50 | | -## Build Tau5Dev |
51 | | - |
52 | | -To build Tau5 in dev mode (with developer tools and auto-loading phoenix server) you just need to change into the `tau5` directory and run the build script: |
53 | | - |
54 | | -``` |
55 | | -cd ~/Development/tau5 |
56 | | -./bin/linux/dev-build-all.sh |
57 | | -``` |
58 | | - |
59 | | -## Run Tau5 in Development Mode |
60 | | - |
61 | | -To run Tau5 in dev mode, just run the `tau5-gui-dev.sh` script |
62 | | - |
63 | | -``` |
64 | | -cd ~/Development/tau5 |
65 | | -./bin/linux/tau5-gui-dev.sh |
66 | | -``` |
67 | | - |
68 | | - |
69 | | - |
70 | | - |
| 1 | +# Linux build instructions for Tau5 |
| 2 | + |
| 3 | +## Install Deps |
| 4 | + |
| 5 | +Tau5 is known to work with the following depencies: |
| 6 | + |
| 7 | +1. gcc or clang |
| 8 | +2. Qt6 (see Qt Version Requirements below) |
| 9 | +3. CMake (3.30+) |
| 10 | +4. Elixir(1.17+) |
| 11 | + |
| 12 | +To install dependencies: |
| 13 | + |
| 14 | +- For full GUI build: `./bin/linux/install-gui-deps.sh` |
| 15 | +- For headless/node only: `./bin/linux/install-node-deps.sh` |
| 16 | + |
| 17 | +Both scripts cover Debian, Redhat, Arch and OpenSuse based distributions. |
| 18 | + |
| 19 | +**Note, that you'll need to use `sudo` so like all other scripts that requre `sudo` that you didn't write yourself - definitely look through the file first to make sure you're happy.** |
| 20 | + |
| 21 | +Once the dependencies are installed double check that your version of Elixir is recent enough. Unfortunately most linux distros don't yet ship with a sufficiently recent version of Elixir. If this is the case for you, you might want to try using [asdf](https://github.com/asdf-vm/asdf). |
| 22 | + |
| 23 | +### Qt Version Requirements |
| 24 | + |
| 25 | +**For tau5-gui (full GUI build):** |
| 26 | +- Minimum: Qt 6.6.0 |
| 27 | +- Maximum tested: Qt 6.9.1 |
| 28 | +- Recommended: Qt 6.9.1 (used in CI for all GUI builds) |
| 29 | + |
| 30 | +**For tau5-node (headless/node only):** |
| 31 | + |
| 32 | +- Minimum: Qt 6.2.4 (available in Ubuntu 22.04 LTS repositories) |
| 33 | +- Maximum tested: Qt 6.9.1 |
| 34 | + |
| 35 | +**Important Notes:** |
| 36 | + |
| 37 | +- Ubuntu 22.04 LTS system packages provide Qt 6.2.4, which is only sufficient for tau5-node builds |
| 38 | +- For GUI builds on Ubuntu 22.04, you must install Qt 6.6.0 or later from qt.io or use the install scripts |
| 39 | + |
| 40 | +## Fetch Tau5 |
| 41 | + |
| 42 | +Find a nice directory to put Tau5 in. I typically use `~/Develolopment`. Change into it and clone the Tau5 github repository: |
| 43 | + |
| 44 | +``` |
| 45 | +cd ~/Development |
| 46 | +git clone https://github.com/samaaron/tau5 |
| 47 | +``` |
| 48 | + |
| 49 | +## Build Tau5Dev |
| 50 | + |
| 51 | +To build Tau5 in dev mode (with developer tools and auto-loading phoenix server) you just need to change into the `tau5` directory and run the build script: |
| 52 | + |
| 53 | +``` |
| 54 | +cd ~/Development/tau5 |
| 55 | +./bin/linux/dev-build-all.sh |
| 56 | +``` |
| 57 | + |
| 58 | +### Run Tau5 in Development Mode |
| 59 | + |
| 60 | +To run Tau5 in dev mode, just run the `tau5-gui-dev.sh` script |
| 61 | + |
| 62 | +``` |
| 63 | +cd ~/Development/tau5 |
| 64 | +./bin/linux/tau5-gui-dev.sh |
| 65 | +``` |
0 commit comments