{{Header}}
'''{{free}}'''
{{mbox
| type = notice
| image = [[File:Ambox_warning_pn.svg.png|40px]]
| text = Note: By proceeding, you acknowledge that you have read, understood, and agreed to our [[Terms of Service|Terms of Service]] and [[License Agreement|License Agreement]].
}}
{{IconSet|h1|1}} Install git.
{{CodeSelect|code=
sudo apt update && sudo apt install git
}}
{{IconSet|h1|2}} Get the source code including git submodules. [
Optional ]git parameters:
* --depth=1: Speeds up the download by fetching only the latest commit.
* --branch {{VersionNew}}-stable: Usability. Checks out the stable branch directly.
* --jobs=4: Speeds up fetching submodules.
* --recurse-submodules --shallow-submodules: Ensures all required submodules are fetched efficiently.
Experienced git users may omit any of these optional parameters.
[
Alternatively, this can be achieved in several steps. This may be useful if network issues arise.
* Over HTTPS:
** {{CodeSelect|code=
git clone --depth=1 --branch {{VersionNew}}-stable --jobs=4 --recurse-submodules --shallow-submodules https://github.com/{{project_name_short}}/derivative-maker.git
}}
* Over SSH:
** Might work better over slow or unstable networks but requires a GitHub account and a configured SSH public key at GitHub. See footnote [A] below.
** {{CodeSelect|code=
git clone --depth=1 --branch {{VersionNew}}-stable git@github.com:{{project_name_short}}/derivative-maker.git
}}
{{CodeSelect|code=
cd derivative-maker
}}
{{CodeSelect|code=
git submodule update --init --recursive --progress --jobs=4
}}
----
[A] GitHub SSH public key setup.
{{IconSet|h1|1}} Create an SSH public key.
See [[SSH]].
{{IconSet|h1|2}} View your SSH public key.
{{CodeSelect|code=
cat ~/.ssh/id_ed25519.pub
}}
{{IconSet|h1|3}} Copy the SSH public key.
{{IconSet|h1|4}} Paste the SSH public key into your GitHub account.
https://github.com/settings/keys
]
Note: Replace {{VersionNew}}-stable with the actual tag or branch you intend to build.
{{CodeSelect|code=
git clone --depth=1 --branch {{VersionNew}}-stable --jobs=4 --recurse-submodules --shallow-submodules git@github.com:{{project_name_short}}/derivative-maker.git
}}
{{IconSet|h1|3}} Check if the above command succeeded.
If there were errors such as:
fatal: unable to access 'https://github.com/.../': Could not resolve host: github.com
Or:
fatal: unable to access 'https://github.com/.../': gnutls_handshake() failed: The TLS connection was non-properly terminated.
then the download likely failed.
Verify success by checking the exit code.
Choose your shell.
{{Tab
|type=controller
|content=
{{Tab
|title= ==Zsh in Kicksecure or Derivatives==
|type=section
|addToClass=info-box
|active=true
|content=
If the last line contains something similar to:
zsh: exit 1
then do not proceed. See footnote. [
Delete the ]derivative-maker source code folder and retry.
sudo rm -r derivative-maker
}}
{{Tab
|title= ==bash and other shells==
|type=section
|addToClass=info-box
|active=false
|content=
Show the exit code.
{{CodeSelect|code=
echo $?
}}
The output should be:
0
If any other exit code is shown, do not proceed and see footnote.