README.md in esr-rim-1.3.2 vs README.md in esr-rim-1.3.3
- old
+ new
@@ -3,10 +3,11 @@
RIM lets you work with multiple git repositories from within one single git repository.
# RIM User Guide
> From RIM version 1.1.4 it is no more necessary to set the global git autocrlf option to false on Windows platforms. If you don't have other reasons you might want to set it back to the recommended value (which is true).
+> From RIM version 1.3.3 the temporary directory used for git repositories is no more placed into the workspace. If the HOME environment variable is set it will be placed into a unique directory under $HOME/.rim
## Concept
RIM is used to synchronize software modules (let's call them library modules) which are git repositories into a project specific git repository. As long as you don't need to upgrade or modify one of the synchronized library modules, you don't need RIM. In other words: if somebody else in the project takes care of the library module synchronization, you can work with one single GIT repository without worrying about RIM or library module synchronization.
When RIM has synchronized a specific version of a library module into your project GIT, it records the source of the library module in the local module directory within a .riminfo file.
@@ -35,10 +36,13 @@
> gem install esr-rim
## Getting started in your project
There's not a lot you have to do to introduce rim into your project. The most important step is:
-Before using rim add the pattern
+
+If you don't want RIM to place .rim folders into your workspaces make sure to define the HOME variable. If defined the working folders will be placed into a .rim folder within the HOME directory.
+
+Otherwise add the pattern
.rim/
to your project's `.gitignore` and commit this change.