wisteria

README

Wisteria

Wisteria is a terminal chat client for the Arbor Chat Project.

About Arbor

Arbor is a chat system that makes communication clearer. It explicitly captures context that other platforms ignore, allowing you to understand the relationship between each message and every other message. It also respects its users and focuses on group collaboration.

You can get information about the Arbor project here.

For news about the project, join our mailing list!

Trying it out

To get started with wisteria, you can follow our Getting Started with Arbor guide.

FAQ

What is this?

wisteria is a minimal terminal arbor client. It is capable of both speaking the Sprout protocol to an Arbor relay and discovering new arbor nodes on disk in order to receive messages.

Why is rendering new nodes on disk useful?

It lets you acquire nodes from essentially any transport. You can store your history in syncthing, dropbox, a mounted google drive folder, or whatever else. This allows you to configure history replication via a variety of protocols and techniques in addition to Sprout.

Developing

Want to work on wisteria? Here's how to do common stuff:

Build a customized version

If you've modified your code and want to take it for a spin, you can use:

go build .

This will place a wisteria executable in the current working directory. You can run that with:

./wisteria

Running the tests

You can run all of our tests by doing:

go test -v -coverprofile=coverage.profile ./...

This will give you lots of feedback about the tests, and will also generate a code coverage report. You can view the code coverage in your browser by running:

go tool cover -html=coverage.profile

Submitting a change

We accept Pull Requests two ways:

SourceHut

Make your own version of the code in a personal SourceHut repo. You can either push your local clone to SourceHut or click the blue "Clone repo to your account" button on this page to get your own copy in SourceHut.

Once you have your own SourceHut repo for wisteria, click the blue "Prepare a patchset" button (in the same place that "Clone repo to your account" was). Choose your branch and the commits within it that you'd like to submit. Once you reach the stage with the title "Finalize the patchset", click to "Add a cover letter" and explain what your PR is for. Feel free to also add commentary to any of the patches.

Once you reach "Review your patchset", send the email to ~whereswaldon/arbor-dev@lists.sr.ht. You should then be able to see your patches and our responses to them here on the mailing list.

GitHub

We have a GitHub wisteria mirror repo. You can submit a Pull Request there.