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.

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

wants to merge 1 commit into from

Conversation

runverzagt
Copy link

Include more complete instructions for new users.

Include more complete instructions for new users.

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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants