Skip to content

Commit

Permalink
update example readme
Browse files Browse the repository at this point in the history
  • Loading branch information
robertwahler committed Aug 7, 2012
1 parent c7fc0c3 commit abd7882
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 3 deletions.
14 changes: 14 additions & 0 deletions README.markdown
Expand Up @@ -50,8 +50,22 @@ Getting started with RepoManager

### installation

dependencies

git > 1.7
ruby 1.87+

installation via gem

gem install repo_manager

installation via source

git clone git://github.com/robertwahler/repo_manager.git
cd repo_manager
bundle
bundle exec rake install

### help

repo --help
Expand Down
32 changes: 29 additions & 3 deletions examples/pc_saved_game_backup/README.markdown
@@ -1,5 +1,5 @@
Using RepoManager to Backup and Synchronize PC Game Saves
=====================================================
=========================================================

Use case: Backup and synchronization of PC save games folders to a
central repository (ie Drop Box folder) using Git. Game saves are
Expand All @@ -18,11 +18,23 @@ This example demonstrates the following features:
Bootstrapping this example folder
--------------------------------

### Gem installation

Install RepoManager, Bundler, and clone the source code repository

gem install repo_manager
gem install bundler

cd ~/examples
git clone https://github.com/robertwahler/repo_manager.git

In order to try out the example commands below, you will need to bootstrap the
sample data git repositories and create the configuration files using the
sample data Git repositories and create the configuration files using the
following commands. See [INSTALL.markdown](INSTALL.markdown) for a more
complete explanation.

cd repo_manager/examples/pc_saved_game_backup

repo generate:remote mines --path=saved_games/mines/saves
repo generate:remote hearts --path=saved_games/hearts

Expand All @@ -37,6 +49,9 @@ Get information on configured saved game repositories
repo status --unmodified DOTS


cd ~/examples
git clone https://github.com/robertwahler/repo_manager.git

User tasks
---------

Expand Down Expand Up @@ -64,6 +79,17 @@ Backup
To backup the saved games, we will need another user task. This on is called
'action:update'. See [repo_manager/tasks/update.rb](repo_manager/tasks/update.rb)

repo action:update

run repo status --short --unmodified=HIDE --no-verbose --no-color from "."
no changed repos

create a new saved game

echo "# dummy save" > saved_games/mines/saves/save3

now run update again

repo action:update

Synchronize
Expand Down Expand Up @@ -94,7 +120,7 @@ Clean
-----
Resetting this example folder back to its shipping defaults

### Delete the git repositories
### Delete the Git repositories

rm -rf remote/hearts.git
rm -rf remote/mines.git
Expand Down

0 comments on commit abd7882

Please sign in to comment.