Merge branch 'master' of github.com:RichiH/vcsh

[code/vcsh.git] / README.md

diff --git a/README.md b/README.md
index 9cc54ad67e32a27b6f28aee1c63c781ea76dc375..e0f78375672f506cf12114218822269b367cb66a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ For example, you may not need to have your `mplayer` configuration on a server
 or available to root and you may want to maintain different configuration for
 `ssh` on your personal and your work machines.
 
 or available to root and you may want to maintain different configuration for
 `ssh` on your personal and your work machines.
 

-A lot of modern UNIX-based systems offer pacakges for `vcsh`. In case yours
+A lot of modern UNIX-based systems offer packages for `vcsh`. In case yours

 does not read `INSTALL.md` for install instructions or `PACKAGING.md` to create
 a package, yourself. If you do end up packaging `vcsh` please let us know so we
 can give you your own packaging branch in the upstream repository.
 does not read `INSTALL.md` for install instructions or `PACKAGING.md` to create
 a package, yourself. If you do end up packaging `vcsh` please let us know so we
 can give you your own packaging branch in the upstream repository.


@@ -65,12 +65,12 @@ All slides, videos, and further information can be found
 There are three different ways to interact with `vcsh` repositories; this
 section will only show the simplest and easiest way.
 Certain more advanced use cases require the other two ways, but don't worry
 There are three different ways to interact with `vcsh` repositories; this
 section will only show the simplest and easiest way.
 Certain more advanced use cases require the other two ways, but don't worry

-about this for now. If you never ewen bother playing with the other two
+about this for now. If you never even bother playing with the other two

 modes you will still be fine.
 `vcsh enter` and `vcsh run`  will be covered in later sections.
 
 
 modes you will still be fine.
 `vcsh enter` and `vcsh run`  will be covered in later sections.
 
 

-## Initialize a new repository "vim"
+## Initialize a new repository called "vim"

 
     vcsh init vim
 
 
     vcsh init vim
 


@@ -97,7 +97,17 @@ modes you will still be fine.
 
     vcsh vim pull
 
 
     vcsh vim pull
 

+## Show status of changed files in all repositories

 
 

+    vcsh status
+
+## Pull from all repositories
+
+    vcsh pull
+
+## Push to all repositories
+
+    vcsh push

 
 # Overview
 
 
 # Overview
 


@@ -206,9 +216,6 @@ you to conveniently run `mr up` etc. to manage all repositories. It looks like
 this:
 
     [DEFAULT]
 this:
 
     [DEFAULT]

-    jobs = 5
-    # Use if your mr does not have vcsh support in mainline, yet
-    include = cat /usr/share/mr/vcsh

     include = cat ${XDG_CONFIG_HOME:-$HOME/.config}/mr/config.d/*
 
 ### repo.d
     include = cat ${XDG_CONFIG_HOME:-$HOME/.config}/mr/config.d/*
 
 ### repo.d


@@ -234,10 +241,8 @@ configuration to a new host.
    example: `vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr`
 2. Choose your repositories by linking them in config.d (or go with the default
    you may have already configured by adding symlinks to git).
    example: `vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr`
 2. Choose your repositories by linking them in config.d (or go with the default
    you may have already configured by adding symlinks to git).

-3. Make sure the line 'include = cat /usr/share/mr/vcsh' in .mrconfig points
-   to an existing file
-4. Run mr to clone the repositories: `cd; mr update`.
-5. Done.
+3. Run mr to clone the repositories: `cd; mr update`.
+4. Done.

 
 Hopefully the above could help explain how this approach saves time by
 
 
 Hopefully the above could help explain how this approach saves time by
 


@@ -298,18 +303,12 @@ and further documentation about the use of AUR is available
 
 #### From source
 
 
 #### From source
 

-If your version of mr is older than version 1.07, make sure to put
-
-    include = cat /usr/share/mr/vcsh
-
-into your .mrconfig .
-

     # choose a location for your checkout
     # choose a location for your checkout

-    cd $HOME

     mkdir -p ~/work/git
     mkdir -p ~/work/git

+    cd ~/work/git

     git clone git://github.com/RichiH/vcsh.git
     cd vcsh
     git clone git://github.com/RichiH/vcsh.git
     cd vcsh

-    ln -s vcsh /usr/local/bin                       # or add it to your PATH
+    sudo ln -s vcsh /usr/local/bin                       # or add it to your PATH

     cd
 
 #### Clone the Template
     cd
 
 #### Clone the Template