expanded page with screenshots, walkthrough, etc

This commit is contained in:
Joey Hess 2012-08-27 14:26:49 -04:00
parent 4f0411cd3b
commit 496a228634
4 changed files with 35 additions and 3 deletions

View file

@ -1,6 +1,38 @@
The git-annex assistant makes git-annex easy to use by providing a
automatic management and syncing of your files, and a friendly web frontend
for configuration.
The git-annex assistant creates a folder on each of your computers, which
it keeps synchronised, so its contents are the same whichever computer it's
used on. It's very easy to use, and has all the power of git and git-annex
underneath.
## quick start
To get started with the git-annex assistant, just run it from the menu:
[[!img assistant/menu.png]]
It'll prompt you to set up the folder:
[[!img assistant/makerepo.png]]
Then any changes you make to its folder will automatically be committed to
git, and synced to repositories on other computers. You can use the
interface to add repositories and control the git-annex assistant.
[[!img assistant/running.png]]
## command line start
The git-annex assistant will automatically be started when you log in to
desktop environments like Gnome, XFCE, and KDE, and the menu item
shown above can be used to open the webapp. On other systems, you may need
to start it by hand.
To start the webapp, run `git annex webapp` at the command line.
To start the assistant without opening the webapp,
you can run the command "git annex assistant --autostart". This is a
good thing to configure your system to run automatically when you log in.
## colophon
The git-annex assistant is being
[crowd funded on

BIN
doc/assistant/makerepo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

BIN
doc/assistant/menu.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

BIN
doc/assistant/running.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB