diff --git a/README.rst b/README.rst index 985bd2b4d3e59b43cc1d920ef3d4c6772fe5b12b..a7a8c592a62c19d30186cde2e28a2a8c9524a106 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ rcfiles ******* A repository with my rc files. The purpose is for me to have revision control of -my home dir, maybe send somebody a link to an example file and to be browsable -for others (if anyone wants to copy some snippet). Because these are my actual -files that I use right now, the repository is cloned directly to my home -directory and is not meant for mass consumption as it is. +my home directory, maybe send somebody a link to an example file and to be +browsable for others (if anyone wants to copy some snippet). Because these are +my actual files that I use right now, the repository is cloned directly to my +home directory and is not meant for mass consumption as it is. Usage ----- @@ -21,6 +21,10 @@ WARNING: This will overwrite your existing files. rm -r rcfiles git submodule update --init --recursive +In older versions of Git the paths in the submodules are obsolete and thus need +to be corrected (before fetching them). The correction needs to be done in the +:code:`.git` and :code:`config` files inside each submodule. + License -------