update(doc|readme|installing): change installing steps
This commit is contained in:
parent
5e8868b660
commit
a73d408462
3 changed files with 22 additions and 17 deletions
|
@ -10,6 +10,7 @@
|
||||||
<w>splt</w>
|
<w>splt</w>
|
||||||
<w>systemd</w>
|
<w>systemd</w>
|
||||||
<w>tutux</w>
|
<w>tutux</w>
|
||||||
|
<w>tuxvenv</w>
|
||||||
<w>webhooks</w>
|
<w>webhooks</w>
|
||||||
</words>
|
</words>
|
||||||
</dictionary>
|
</dictionary>
|
||||||
|
|
10
Makefile
10
Makefile
|
@ -1,4 +1,14 @@
|
||||||
PYTHON = python
|
PYTHON = python
|
||||||
|
VENV = ~/tuxvenv
|
||||||
|
|
||||||
|
# Init
|
||||||
|
main:
|
||||||
|
$(PYTHON) -m venv --clear $(VENV)
|
||||||
|
$(VENV)/bin/pip install -U pip setuptools
|
||||||
|
install:
|
||||||
|
$(VENV)/bin/pip install .
|
||||||
|
update:
|
||||||
|
$(VENV)/bin/pip install -U .
|
||||||
|
|
||||||
# Blackify code
|
# Blackify code
|
||||||
reformat:
|
reformat:
|
||||||
|
|
28
README.md
28
README.md
|
@ -22,7 +22,7 @@ It is preferable to install the bot on a dedicated user. If you don't know how t
|
||||||
sudo pacman -Syu python python-pip python-virtualenv git
|
sudo pacman -Syu python python-pip python-virtualenv git
|
||||||
```
|
```
|
||||||
|
|
||||||
Continue by [creating virtual env](#creating-a-virtual-env).
|
Continue to [installing Tuxbot](#installing-tuxbot).
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ sudo apt update
|
||||||
sudo apt -y install python3 python3-dev python3-pip python3-venv git
|
sudo apt -y install python3 python3-dev python3-pip python3-venv git
|
||||||
```
|
```
|
||||||
|
|
||||||
Continue by [creating virtual env](#creating-a-virtual-env).
|
Continue to [installing Tuxbot](#installing-tuxbot).
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -41,25 +41,19 @@ Continue by [creating virtual env](#creating-a-virtual-env).
|
||||||
|
|
||||||
*go to hell*
|
*go to hell*
|
||||||
|
|
||||||
## Creating a virtual env
|
|
||||||
|
|
||||||
Make sure you have the virtualenv package installed before following the next steps.
|
|
||||||
|
|
||||||
Create the virtual environment by executing the following command:
|
|
||||||
```shell script
|
|
||||||
python3 -m venv ~/tuxvenv
|
|
||||||
```
|
|
||||||
|
|
||||||
And activate it with this command:
|
|
||||||
```shell script
|
|
||||||
source ~/tuxvenv/bin/activate
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installing Tuxbot
|
## Installing Tuxbot
|
||||||
|
|
||||||
Now, you can finish the installation by executing this single command:
|
To set up the virtual environnement and install the bot, simply run this two commands:
|
||||||
|
|
||||||
```shell script
|
```shell script
|
||||||
pip install .
|
make
|
||||||
|
make install
|
||||||
|
```
|
||||||
|
|
||||||
|
Now, switch your environment to the virtual one by run this single command:
|
||||||
|
```shell script
|
||||||
|
source ~/tuxvenv/bin/activate
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
Loading…
Reference in a new issue