From 77896494c4fd58b6428ee76bb87454c4016a9894 Mon Sep 17 00:00:00 2001 From: OofChair Date: Wed, 3 Mar 2021 11:14:15 -0500 Subject: [PATCH] [Docs] Add `nano` package to Linux install guides (#4870) * [Docs] Add installation instructions for nano As some servers don't have nano preinstalled, I added the installation instructions here. * Formatting fix * Update autostart_systemd.rst * Add nano to installation instructions * Add nano to all OS installation instructions * Remove nano from OSX installation Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> * Remove trailing whitspace Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> * Put nano at the end Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> * Put nano at the end Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> * Put nano at the end Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> * Put nano at the end Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> * Update install_linux_mac.rst * Minimize diffs Co-authored-by: kreusada <67752638+kreusada@users.noreply.github.com> Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> --- docs/install_linux_mac.rst | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/install_linux_mac.rst b/docs/install_linux_mac.rst index 3f63a3c25..08b79263f 100644 --- a/docs/install_linux_mac.rst +++ b/docs/install_linux_mac.rst @@ -22,8 +22,7 @@ The pre-requirements are: - Git 2.11+ - Java Runtime Environment 11 (for audio support) -We also recommend installing some basic compiler tools, in case our dependencies don't provide -pre-built "wheels" for your architecture. +We recommend installing the nano text editor as our guides may instruct you to create or edit some files. We also recommend installing some basic compiler tools in case our dependencies don't provide pre-built "wheels" for your architecture. ***************** @@ -43,7 +42,7 @@ Arch Linux .. code-block:: none - sudo pacman -Syu python python-pip git jre11-openjdk-headless base-devel + sudo pacman -Syu python python-pip git jre11-openjdk-headless base-devel nano Continue by `creating-venv-linux`. @@ -59,7 +58,7 @@ CentOS and RHEL 7 .. code-block:: none sudo yum -y groupinstall development - sudo yum -y install zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel openssl-devel xz xz-devel tk-devel libffi-devel findutils java-11-openjdk-headless + sudo yum -y install zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel openssl-devel xz xz-devel tk-devel libffi-devel findutils java-11-openjdk-headless nano sudo yum -y install centos-release-scl sudo yum -y install devtoolset-8-gcc devtoolset-8-gcc-c++ echo "source scl_source enable devtoolset-8" >> ~/.bashrc @@ -88,7 +87,7 @@ CentOS and RHEL 8 sudo yum -y install epel-release sudo yum -y update sudo yum -y groupinstall development - sudo yum -y install git zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel openssl-devel xz xz-devel tk-devel libffi-devel findutils java-11-openjdk-headless + sudo yum -y install git zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel openssl-devel xz xz-devel tk-devel libffi-devel findutils java-11-openjdk-headless nano Complete the rest of the installation by `installing Python 3.8 with pyenv `. @@ -107,7 +106,7 @@ Debian/Raspbian Buster. This guide will tell you how. First, run the following c .. code-block:: none sudo apt update - sudo apt -y install make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-11-jre-headless + sudo apt -y install make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-11-jre-headless nano CXX=/usr/bin/g++ Complete the rest of the installation by `installing Python 3.8 with pyenv `. @@ -125,7 +124,7 @@ them with dnf: .. code-block:: none - sudo dnf -y install python38 git java-11-openjdk-headless @development-tools + sudo dnf -y install python38 git java-11-openjdk-headless @development-tools nano Continue by `creating-venv-linux`. @@ -183,7 +182,7 @@ Now install the pre-requirements with zypper: .. code-block:: none - sudo zypper -n install opt-python38 opt-python38-setuptools git-core java-11-openjdk-headless + sudo zypper -n install opt-python38 opt-python38-setuptools git-core java-11-openjdk-headless nano sudo zypper -n install -t pattern devel_basis Since Python is now installed to ``/opt/python``, we should add it to PATH. You can add a file in @@ -210,7 +209,7 @@ with zypper: .. code-block:: none - sudo zypper -n install python3-base python3-pip git-core java-11-openjdk-headless + sudo zypper -n install python3-base python3-pip git-core java-11-openjdk-headless nano sudo zypper -n install -t pattern devel_basis Continue by `creating-venv-linux`. @@ -241,7 +240,7 @@ Now install the pre-requirements with apt: .. code-block:: none - sudo apt -y install python3.8 python3.8-dev python3.8-venv python3-pip git openjdk-11-jre-headless build-essential + sudo apt -y install python3.8 python3.8-dev python3.8-venv python3-pip git openjdk-11-jre-headless build-essential nano Continue by `creating-venv-linux`. @@ -265,7 +264,7 @@ Now install the pre-requirements with apt: .. code-block:: none - sudo apt -y install python3.8 python3.8-dev python3.8-venv python3-pip git openjdk-11-jre-headless build-essential + sudo apt -y install python3.8 python3.8-dev python3.8-venv python3-pip git openjdk-11-jre-headless build-essential nano Continue by `creating-venv-linux`. @@ -290,7 +289,7 @@ installing pyenv. To do this, first run the following commands: .. code-block:: none - sudo apt -y install make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-11-jre-headless + sudo apt -y install make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-11-jre-headless nano CXX=/usr/bin/g++ And then complete the rest of the installation by `installing Python 3.8 with pyenv `.