add a pairing walkthrough

1 files changed, 49 insertions, 0 deletions

diff --git a/doc/assistant/pairing_walkthrough.mdwn b/doc/assistant/pairing_walkthrough.mdwn
new file mode 100644
index 000000000..112c19eb0
--- /dev/null
+++ b/doc/assistant/pairing_walkthrough.mdwn
@@ -0,0 +1,49 @@
+So you have two computers in the same building, and you want them to share
+the same synchronised folder, communicating directly with each other.
+
+This is incredibly easy to set up with the git annex assistant.
+
+Let's say the two computers are your computer and your friend's computer.
+We'll start on your computer, where you open up your git annex dashboard.
+
+[[!img addrepository.png alt="Add another repository button"]]
+
+`*click*`
+
+[[!img pairing.png alt="Pair with local computer"]]
+
+Now the hard bit. You have to think up a secret phrase, and type it in..
+
+[[!img secret.png alt="Enter secret phrase"]]
+
+Now your computer is in pairing mode. When your friend looks at her git
+annex dashboard, she sees something like this.
+
+[[!img pairrequest.png alt="Pair request"]]
+
+`*click*`
+
+[[!img secretempty.png alt="Enter same secret phrase"]]
+
+Now it's up to you to let her know what the secret is. As soon as she
+enters it, both your computers will be paired, and will begin to sync their
+git-annex folders. Just like that you can share files.
+
+----
+
+Something to keep in mind, especially if pairing doesn't seem to be
+working, is that the two computer need to be on the same network for this
+pairing process to work. Sometimes a building will have more than one
+network inside it, and you'll need to connect them both to the same one.
+Make sure the wireless network name is the same, or that they're both
+plugged into the same router.
+
+Also, the file sharing set up by this pairing only works when both
+computers are on the same network. If you go on a trip, any files you
+edit will not be visible to your friend until you get back. **But**,
+you can get around this by hooking both computers up to a server on the
+internet, which they can use to exchange files. The git annex assistant
+makes that easy too.
+
+And also, you can pair with as many other computers as you like, not just
+one!