Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #50

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,28 @@ to a Matrix server and send messages.
If you are interested in helping out take a look at the issue tracker.

# Build
Ensure the following are downloaded:
* [Weechat Source](https://weechat.org/download/) (does not need to be built, just the same version as is installed)
* [Rust](https://www.rust-lang.org/learn/get-started) (follow installation instructions)

After Rust is installed the plugin can be compiled with:
You need Weechat source code to get the file `weechat-plugin.h`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we swap the order of this around, mention that the source file is needed only if it isn't there already, weechat-plugin.h tends to be around on a bunch of distros if you install Weechat, other distros might have a weechat-dev package which installs it as well.

Or perhaps have two sections:

I have weechat-plugin.h installed with Weechat

  1. Steps
  2. to build
  3. ...

I'm missing weechat-plugin.h

...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, understood.

My goal was to avoid people having the same issue that I did, which was the local version of weechat-plugin.h did not match the installed version of Weechat. Perhaps I could add add a troubleshooting section and put info there?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, that works as well.


cargo build
After Rust is installed the plugin can be compiled with the following (use correct path for `weechat-plugin.h`):

On Linux this creates a `libmatrix.so` file in the `target/debug/` folder, this
file needs to be renamed to `matrix.so` and copied to your Weechat plugin
directory. A plugin directory can be created in your `$WEECHAT_HOME` folder, by
WEECHAT_PLUGIN_FILE=/PATH/TO/WEECHAT/src/plugins/weechat-plugin.h make install

On Linux this will build and install the plugin in your `$WEECHAT_HOME`.



Alternatively, if `weechat-plugin.h` is globaly visible, `cargo build` creates a
`libmatrix.so` file in the `target/debug/` folder, this file needs to be renamed to
`matrix.so` and copied to your Weechat plugin directory.
A plugin directory can be created in your `$WEECHAT_HOME` folder, by
default `.weechat/plugins/`.

Alternatively `make install` will build and install the plugin in your
`$WEECHAT_HOME` as well.
# Usage
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's mention that the /help matrix command lists out all the Matrix specific commands with a short description.


1. Add a server using `/matrix server add [server-name] [server-url]`. Make sure the url includes the scheme (eg 'https://matrix.org').
2. Add username and password: `/set matrix-rust.server.[server-name].username [username]` and `/set matrix-rust.server.[server-name].password [password]`.
3. Connect to server using `/matrix connect [server-name]`. This may take several minutes, be patient.