Skip to content

Latest commit

 

History

History
173 lines (104 loc) · 7.31 KB

INSTALLATION.md

File metadata and controls

173 lines (104 loc) · 7.31 KB
Raw

Installation

Contents

Dependencies

  • Android users should install NeoTerm App.

  • python3 and optionally pip3 should be installed in your system.

    • NeoTerm (non-root shell): pkg install python. Check https://wiki.neoterm.com/wiki/Python for details. pip will automatically be installed.
    • Linux distros: sudo apt install python3 python3-pip.

  • The ruamel.yaml python module is used to load YAML manifest files. Check Install instructions for more info.

    • NeoTerm (non-root shell): pip install ruamel.yaml.
    • Linux distros: sudo pip3 install ruamel.yaml.

NeoTerm In Android Installation From Repository

pkg install neoterm-create-package

NeoTerm In Android Installation From Source

The neoterm-create-package file should be installed in neoterm bin directory /data/data/io.neoterm/files/usr/bin.
It should have neoterm uid:gid ownership and have readable 700 permission before it can be sourced.

Basic

pkg install curl && \
export install_path="/data/data/io.neoterm/files/usr/bin" && \
mkdir -p "$install_path" && \
curl -L 'https://github.com/theworkjoy/neoterm-create-package/releases/latest/download/neoterm-create-package' -o "$install_path/neoterm-create-package" && \
export owner="$(stat -c "%u" "$install_path")"; chown "$owner:$owner" "$install_path/neoterm-create-package" && \
chmod 700 "$install_path/neoterm-create-package";

Advance

  1. Export install directory path and create it.
export install_path="/data/data/io.neoterm/files/usr/bin"
mkdir -p "$install_path"

  1. Download the neoterm-create-package file.

    • Download to install directory directly from github using curl using a non-root neoterm shell.
      Run pkg install curl to install curl first.

      • Latest release:

        curl -L 'https://github.com/theworkjoy/neoterm-create-package/releases/latest/download/neoterm-create-package' -o "$install_path/neoterm-create-package"

      • Specific release:

        curl -L 'https://github.com/theworkjoy/neoterm-create-package/releases/download/v0.12.0/neoterm-create-package' -o "$install_path/neoterm-create-package"

      • Master Branch may be unstable:

        curl -L 'https://github.com/theworkjoy/neoterm-create-package/raw/master/src/neoterm-create-package' -o "$install_path/neoterm-create-package"

    • Download neoterm-create-package file manually from github to the android download directory and then copy it to install directory.

      You can download the neoterm-create-package file from a github release from the Assets dropdown menu.

      You can also download it from a specific github branch/tag by opening the neoterm-create-package file from the Code section.
      Right-click or hold the Raw button at the top and select Download/Save link.

      Then copy the file to install directory using cat command below or use a root file browser to manually place it.

      cat "/storage/emulated/0/Download/neoterm-create-package" > "$install_path/neoterm-create-package"

  2. Set neoterm ownership and readable permissions.

    • If you used a curl or cat to copy the file, then use a non-root neoterm shell to set ownership and permissions with chown and chmod commands respectively:

      export owner="$(stat -c "%u" "$install_path")"; chown "$owner:$owner" "$install_path/neoterm-create-package" && chmod 700 "$install_path/neoterm-create-package";

    • If you used a root file browser to copy the file, then use su to start a root shell to set ownership and permissions with chown and chmod commands respectively:

      export owner="$(stat -c "%u" "$install_path")"; su -c "chown \"$owner:$owner\" \"$install_path/neoterm-create-package\" && chmod 700 \"$install_path/neoterm-create-package\"";

    • Or manually set them with your root file browser. You can find neoterm uid and gid by running the command id -u in a non-root neoterm shell or by checking the properties of the neoterm bin directory from your root file browser.

Linux Distros System Installation From Repository

sudo pip3 install neoterm-create-package

Linux Distros System Installation From Source

The neoterm-create-package file should be placed in the /usr/local/bin directory if you want to install it system-wide for all users as per FHS 3.0.
It should have readable 755 permission before it can be sourced.

The install command for curl is for Ubuntu/Debian, it may be different for other distros.

Basic

sudo apt install curl && \
export install_path="/usr/local/bin" && \
sudo mkdir -p "$install_path" && \
sudo curl -L 'https://github.com/theworkjoy/neoterm-create-package/releases/latest/download/neoterm-create-package' -o "$install_path/neoterm-create-package" && \
sudo chmod 755 "$install_path/neoterm-create-package";

Advance

  1. Export install directory path and create it.
export install_path="/usr/local/bin"
mkdir -p "$install_path"

  1. Download the neoterm-create-package file.

    • Download to install directory directly from github using curl using a root shell with sudo.
      Run sudo apt install curl to install curl first.

      • Latest release:

        sudo curl -L 'https://github.com/theworkjoy/neoterm-create-package/releases/latest/download/neoterm-create-package' -o "$install_path/neoterm-create-package"

      • Specific release:

        sudo curl -L 'https://github.com/theworkjoy/neoterm-create-package/releases/download/v0.12.0/neoterm-create-package' -o "$install_path/neoterm-create-package"

      • Master Branch may be unstable:

        sudo curl -L 'https://github.com/theworkjoy/neoterm-create-package/raw/master/src/neoterm-create-package' -o "$install_path/neoterm-create-package"

    • Download neoterm-create-package file manually from github to the install directory.

      You can download the neoterm-create-package file from a github release from the Assets dropdown menu.

      You can also download it from a specific github branch/tag by opening the neoterm-create-package file from the Code section.
      Right-click or hold the Raw button at the top and select Download/Save link.

      Then copy the file to install directory using cat command below or use a root file browser to manually place it (sudo nautilus).

      sudo cat "neoterm-create-package" > "$install_path/neoterm-create-package"

  2. Set readable permissions.

    • Set ownership and permissions with chown and chmod commands respectively:

      sudo chmod 755 "$install_path/neoterm-create-package"