Skip to content

A few updates to the README.markdown #78

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

Open
sycamoreone wants to merge 4 commits into
base: master
Choose a base branch
from
Open

A few updates to the README.markdown #78

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3dba8f6
Remove mercurial from the build instructions.
sycamoreone Feb 2, 2015
8cf086f
Update the example chats.
sycamoreone Feb 9, 2015
a69eee7
Don't use $GOPATH to run the client.
sycamoreone Feb 9, 2015
4063f65
Update an outdated comment about Tails.
sycamoreone Feb 9, 2015
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
45 changes: 29 additions & 16 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,30 @@ Messages are sent by entering the JID of a contact and hitting tab to complete t

> friend@example.com: Hi there!

On subsequent lines you don't have to enter their address again, unless you want to direct messages to someone else:
On subsequent lines the address of the current chat target is contained in the prompt and you don't have to enter it again, unless you want to direct messages to someone else:

> friend@example.com: Hi there!
> I was thinking
> about that thing
> otherfriend@example.com: I'll be right with you!
> friend@example.com: back again
> friend@example.com> I was thinking
> friend@example.com> about that thing
> friend@example.com> otherfriend@example.com: I'll be right with you!
> otherfriend@example.com> friend@example.com: back again
> friend@example.com> ...

Messages from others are written in a similar fashion: the address is omitted for subsequent lines and replaced with a colon. The colon is red for unencrypted and green for encrypted.
You can also clear the current chat target using the /close command.

> friend@example.com: Hi there!
> friend@example.com> I was thinking about that thing.
> friend@example.com> /close
>
> otherfriend@example.com: Where were we?

Messages from others are written in a similar fashion:

> friend@example.com: Where were we at?
(Feb 9 20:40:22) : friend@example.com: You wanted to tell me
(Feb 9 20:40:27) : friend@example.com: about that thing.

The addresses are always red for unencrypted and green for encrypted chats.

If a contact name isn't recognised before a colon then it's ignored. Don't assume that you're sending a message to who you think you are unless you tab completed the address.

Expand All @@ -41,13 +56,14 @@ Installation instructions

Build and run instructions for Ubuntu 13.10 (codename Saucy Salamander, go version 1.1.2). Note the version of Go shipped with this distro is very old any may be broken now.

sudo apt-get install git golang mercurial
sudo apt-get install git golang
export GOPATH=$HOME/go
go get github.com/agl/xmpp-client
$GOPATH/bin/xmpp-client

~/go/bin/xmpp-client

## If you want to set up an alias
echo "alias xmpp-client='$GOPATH/bin/xmpp-client' " >> ~/.bashrc
echo "alias xmpp-client='$HOME/go/bin/xmpp-client' " >> ~/.bashrc
. ~/.bashrc
xmpp-client

Expand All @@ -56,14 +72,11 @@ Build and run instructions for Tails (tested on version 1.2, go version 1.2)
## If you don't have already
sudo apt-get update

## Debian old-stable, on which Tails is currently based, doesn't have Go packages
## Debian stable, on which Tails is currently based, contains an outdated Go package.
sudo apt-get install -t unstable golang

## Git is already included in tails so we only need to get Mercurial
sudo apt-get install mercurial

## Assuming you have created a persistant volume
## Assuming you have created a persistent volume
export GOPATH=/home/amnesia/Persistent/go/

go get github.com/agl/xmpp-client
$GOPATH/bin/xmpp-client

~/Persistent/go/bin/xmpp-client