diff --git a/docs/index.rst b/docs/index.rst index 068a8e773..7f82e0bff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,7 +12,8 @@ Welcome to Red - Discord Bot's documentation! install_windows install_mac - install_ubuntu + install_ubuntu_xenial + install_ubuntu_bionic install_debian install_centos install_arch diff --git a/docs/install_centos.rst b/docs/install_centos.rst index 265419201..054f21c2e 100644 --- a/docs/install_centos.rst +++ b/docs/install_centos.rst @@ -14,8 +14,7 @@ Installing pre-requirements yum -y groupinstall development yum -y install https://centos7.iuscommunity.org/ius-release.rpm - yum -y install yum-utils wget which python35u python35u-pip python35u-devel openssl-devel libffi-devel git java-1.8.0-openjdk - sh -c "$(wget https://gist.githubusercontent.com/mustafaturan/7053900/raw/27f4c8bad3ee2bb0027a1a52dc8501bf1e53b270/latest-ffmpeg-centos6.sh -O -)" + yum -y install yum-utils wget which python36u python36u-pip python36u-devel openssl-devel libffi-devel git java-1.8.0-openjdk -------------- Installing Red diff --git a/docs/install_debian.rst b/docs/install_debian.rst index 648ebc1f3..4bd58f610 100644 --- a/docs/install_debian.rst +++ b/docs/install_debian.rst @@ -12,9 +12,24 @@ Installing pre-requirements .. code-block:: none - echo "deb http://httpredir.debian.org/debian stretch-backports main contrib non-free" >> /etc/apt/sources.list - apt-get update - apt-get install python3.5-dev python3-pip build-essential libssl-dev libffi-dev git unzip default-jre -y + sudo apt install -y make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev git unzip default-jre + curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash + +After that last command, you may see a warning about 'pyenv' not being in the load path. Follow the instructions given to fix that, then close and reopen your shell + +Then run the following command: + +.. code-block:: none + + CONFIGURE_OPTS=--enable-optimizations pyenv install 3.6.5 -v + +This may take a long time to complete. + +After that is finished, run: + +.. code-block:: none + + pyenv global 3.6.5 ------------------ Installing the bot diff --git a/docs/install_raspbian.rst b/docs/install_raspbian.rst index 0015b4e10..fd18a43d5 100644 --- a/docs/install_raspbian.rst +++ b/docs/install_raspbian.rst @@ -12,8 +12,24 @@ Installing pre-requirements .. code-block:: none - sudo apt-get install python3.5-dev python3-pip build-essential libssl-dev libffi-dev git unzip default-jre -y + sudo apt install -y make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev git unzip default-jre + curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash +After that last command, you may see a warning about 'pyenv' not being in the load path. Follow the instructions given to fix that, then close and reopen your shell + +Then run the following command: + +.. code-block:: none + + CONFIGURE_OPTS=--enable-optimizations pyenv install 3.6.5 -v + +This may take a long time to complete. + +After that is finished, run: + +.. code-block:: none + + pyenv global 3.6.5 -------------- Installing Red diff --git a/docs/install_ubuntu.rst b/docs/install_ubuntu_bionic.rst similarity index 93% rename from docs/install_ubuntu.rst rename to docs/install_ubuntu_bionic.rst index cb5eeda23..b3eb4b0ec 100644 --- a/docs/install_ubuntu.rst +++ b/docs/install_ubuntu_bionic.rst @@ -1,7 +1,7 @@ -.. ubuntu install guide +.. ubuntu bionic install guide ============================== -Installing Red on Ubuntu 16.04 +Installing Red on Ubuntu 18.04 ============================== .. warning:: For safety reasons, DO NOT install Red with a root user. Instead, `make a new one `_. @@ -12,7 +12,7 @@ Installing the pre-requirements .. code-block:: none - sudo apt install python3.5-dev python3-pip build-essential libssl-dev libffi-dev git unzip default-jre -y + sudo apt install python3.6-dev python3-pip build-essential libssl-dev libffi-dev git unzip default-jre -y ------------------ diff --git a/docs/install_ubuntu_xenial.rst b/docs/install_ubuntu_xenial.rst new file mode 100644 index 000000000..981b0bdf7 --- /dev/null +++ b/docs/install_ubuntu_xenial.rst @@ -0,0 +1,59 @@ +.. ubuntu xenial install guide + +============================== +Installing Red on Ubuntu 16.04 +============================== + +.. warning:: For safety reasons, DO NOT install Red with a root user. Instead, `make a new one `_. + +------------------------------- +Installing the pre-requirements +------------------------------- + +.. code-block:: none + + sudo apt install software-properties-common + sudo add-apt-repository ppa:deadsnakes/ppa + sudo apt update + sudo apt install python3.6-dev build-essential libssl-dev libffi-dev git unzip default-jre wget -y + wget https://bootstrap.pypa.io/get-pip.py + sudo python3.6 get-pip.py + + +------------------ +Installing the bot +------------------ + +To install without audio: + +:code:`pip3.6 install -U --process-dependency-links red-discordbot --user` + +To install with audio: + +:code:`pip3.6 install -U --process-dependency-links red-discordbot[voice] --user` + +To install the development version (without audio): + +:code:`pip3.6 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot --user` + +To install the development version (with audio): + +:code:`pip3.6 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice] --user` + +------------------------ +Setting up your instance +------------------------ + +Run :code:`redbot-setup` and follow the prompts. It will ask first for where you want to +store the data (the default is :code:`~/.local/share/Red-DiscordBot`) and will then ask +for confirmation of that selection. Next, it will ask you to choose your storage backend +(the default here is JSON). It will then ask for a name for your instance. This can be +anything as long as it does not contain spaces; however, keep in mind that this is the +name you will use to run your bot, and so it should be something you can remember. + +----------- +Running Red +----------- + +Run :code:`redbot ` and run through the initial setup. This will ask for +your token and a prefix. diff --git a/docs/install_windows.rst b/docs/install_windows.rst index b841113ba..85726554f 100644 --- a/docs/install_windows.rst +++ b/docs/install_windows.rst @@ -8,7 +8,7 @@ Installing Red on Windows Needed Software --------------- -* `Python `_ - Red needs at least Python 3.5 +* `Python `_ - Red needs Python 3.6 .. note:: Please make sure that the box to add Python to PATH is CHECKED, otherwise you may run into issues when trying to run Red