You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

92 lines
3.2 KiB
Org Mode

3 years ago
#+TITLE: weechat-xmpp
7 years ago
#+AUTHOR: Tony Olagbaiye
#+EMAIL: frony0@gmail.com
7 years ago
#+DATE: 2018-05-09
3 years ago
#+DESCRIPTION: Weechat plugin for XMPP
#+KEYWORDS: weechat xmpp c api
7 years ago
#+LANGUAGE: en
#+OPTIONS: H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
#+OPTIONS: TeX:t LaTeX:nil skip:nil d:nil todo:t pri:t tags:not-in-toc
7 years ago
#+EXPORT_EXCLUDE_TAGS: exclude
#+STARTUP: showall
3 years ago
[[https://travis-ci.org/bqv/weechat-xmpp][file:https://api.travis-ci.org/bqv/weechat-xmpp.svg?branch=master]]
[[https://coveralls.io/github/bqv/weechat-xmpp?branch=master][file:https://coveralls.io/repos/github/bqv/weechat-xmpp/badge.svg?branch=master]]
[[https://github.com/bqv/weechat-xmpp/issues][file:https://img.shields.io/github/issues/bqv/weechat-xmpp.svg]]
[[https://github.com/bqv/weechat-xmpp/issues?q=is:issue+is:closed][file:https://img.shields.io/github/issues-closed/bqv/weechat-xmpp.svg]]
[[https://github.com/bqv/weechat-xmpp/blob/master/LICENSE][file:https://img.shields.io/github/license/bqv/weechat-xmpp.svg]]
[[https://github.com/bqv/weechat-extras/][file:https://img.shields.io/badge/weechat--extras-xmpp-blue.svg]]
7 years ago
3 years ago
| Status: | Aaaaaaaaaaaaaaaaa |
| Location: | [[http://github.com/bqv/weechat-xmpp]] |
| Version: | 0.1.0 |
| Disclaimer: | I'm lazy |
7 years ago
* Description
A weechat plugin in C to extend the chat client to
3 years ago
support XMPP and ideally a maximal set of XEPs.
* Usage
3 years ago
1. Start with =/xmpp register= for instructions on how
to obtain a token, or if you already have a token, use
3 years ago
=/xmpp register <token>=.
3 years ago
2. Use =/xmpp connect <workspace-name>= with the name
returned by register
7 years ago
7 years ago
* Installing
3 years ago
Place xmpp.so in the appropriate place for weechat plugins.
7 years ago
7 years ago
* Dependencies
3 years ago
- libstrophe (static, submodule)
7 years ago
- json-c (static, submodule)
- weechat (>= v1.7)
7 years ago
* Building
#+begin_src sh
3 years ago
git clone git://github.com/bqv/weechat-xmpp.git
cd weechat-xmpp
7 years ago
make
make install
#+end_src
Do *NOT* run make install as root, it installs the plugin to your
local weechat plugins directory
* Development
I use emacs for development of this, although I am also a fan of vim.
My debug build process involves static analysis with clang and cppcheck,
and dynamic analysis with address-sanitizer and leak-sanitizer.
My debug evaluation process involves gdb/mi run with the arguments
=-ex "handle SIGPIPE nostop noprint pass" --args weechat -a 2>asan.log=
since part of weechat and it's default plugins use SIGPIPE as control.
I have no real requests for style of pull requests besides a wish that
you keep vaguely to the style I have adopted for this project.
Happy coding!
7 years ago
* Tasks
3 years ago
** TODO [#A] Implement basic functionality (milestone v0.1)
** TODO [#A] Implement essential events (milestone v0.2)
** TODO [#B] Implement completion engine (milestone v0.3)
** TODO [#D] Close all issues (milestone v1.0)
7 years ago
* Contributing
*Your contributions are always welcome!*
Please submit a pull request or create an issue
to add a new or missing feature.
* License
3 years ago
weechat-xmpp is licensed under the Mozilla Public
7 years ago
License Version 2.0 available [[https://www.mozilla.org/en-US/MPL/2.0/][here]] and in LICENSE.