Skip to content

Commit

Permalink
README: Clarify the Install section.
Browse files Browse the repository at this point in the history
1. Install libolm
2. Add the possibility to install dependencies via requirements.txt
3. Not modified
  • Loading branch information
tamwile authored and poljar committed Mar 22, 2019
1 parent 32f4448 commit 5062c4c
Showing 1 changed file with 40 additions and 22 deletions.
62 changes: 40 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,46 @@ support is still experimental.

# Installation

Installation is easy. As your regular user, just run: `make install` in this repository directory.

The following Python modules must also be available on your system:

- pyOpenSSL
- typing
- webcolors
- future (Python2 users only, see below)
- atomicwrites
- [matrix-nio](https://github.com/poljar/matrix-nio)
- attrs
- logbook
- pygments

Note that weechat only supports Python2 OR Python3, and that setting is
determined at the time that Weechat is compiled. Weechat-Matrix can work with
either Python2 or Python3, but when you install dependencies you will have to
take into account which version of Python your Weechat was built to use.

To check the python version that weechat is using, run:

/python version
1. Install libolm

- Ubuntu
```
sudo apt-get install libolm-dev
```

- Debian (see https://git.matrix.org/git/olm)

- Archlinux based distribution (see https://aur.archlinux.org/packages/libolm/)
use your favorite pacman frontend with AUR support (yaourt, yay, pikaur, …)

2. Clone the repo and install dependencies
```
git clone https://github.com/poljar/weechat-matrix.git
cd weechat-matrix
pip install -r requirements.txt
```

Another option is to install the dependencies manually:
- pyOpenSSL
- typing
- webcolors
- future (Python2 users only, see below)
- atomicwrites
- [matrix-nio](https://github.com/poljar/matrix-nio)
- attrs
- logbook
- pygments

3. As your regular user, just run: `make install` in this repository directory.

Note that weechat only supports Python2 OR Python3, and that setting is
determined at the time that Weechat is compiled. Weechat-Matrix can work with
either Python2 or Python3, but when you install dependencies you will have to
take into account which version of Python your Weechat was built to use.

To check the python version that weechat is using, run:

/python version

## Uploads

Expand Down

0 comments on commit 5062c4c

Please sign in to comment.