Commits

Christian Specht committed e56abc1

move information from the wiki to the readme file

Comments (0)

Files changed (1)

 
 RoboShell Backup consists of two batch files:
 
-- `PcToNas.bat` copies folders from your local machine to a NAS drive.
-- `NasToUsb.bat` backups the whole NAS drive to an external USB disk.
+- `PcToNas.bat` copies folders from your local machine to a NAS drive.  
+You can  specify in the `config.xml` file:  
+  - the local folders to be copied
+  - the drive letter of the NAS drive
+  - the name of the destination folder on the NAS drive
+- `NasToUsb.bat` backups the whole NAS drive to an external USB disk.  
+You can specify the drive letter of the USB disk in the `config.xml` file.
 
 There is a config file in which you can specify the local folders to be backed up, and the drive letters of the NAS and USB drives.
 
-## How to install?
+The idea is that you run `PcToNas.bat` regularly on each of your machines, so that all your important data is always on your NAS drive, including the local stuff from each machine.  
+Then, every time you feel like taking a complete backup of your NAS, you plug an external USB drive to any of your machines and run `NasToUsb.bat` to copy the whole NAS on the USB drive.
 
-In order to use RoboShell Backup, you need to have RoboCopy and Windows Powershell installed and in your `%PATH%` variable.  
-Depending on your Windows version, this may already be the case.
+RoboShell Backup mirrors the copied files using RoboCopy's `/MIR` switch, which means that only changed, deleted and new files will be touched at all.
+So, making a backup doesn't take much time (except for the very first run, of course).
 
-The installation itself is easy, just run the setup.  
-When the installation has finished, the config file will open automatically in Notepad. You need to change the values in the config file once, according to your setup (which folders to backup, drive letters of your NAS and your USB drive).
+## Setup
 
-For more information on the installation (and how to get RoboCopy and Windows PowerShell if it's not already on your machine), see the [wiki](https://bitbucket.org/christianspecht/roboshell-backup/wiki/Install).
+RoboShell Backup assumes that RoboCopy and Windows Powershell are both installed on your machine and in your `%PATH%` variable.  
+Depending on your Windows version, this may already be the case (see below for more information).
 
-### Developers
+The installation of RoboShell Backup itself is easy, just run the setup.  
+When the installation has finished, the config file will automatically open in Notepad. You need to change the values in the config file once, according to your setup (which folders to backup, drive letters of your NAS and your USB drive).
 
-Information for developers is available in the [wiki](https://bitbucket.org/christianspecht/roboshell-backup/wiki/Developers).
+#### How to get RoboCopy and PowerShell
+
+RoboCopy will be on your machine and in your `%PATH%` variable if you have at least Windows Vista (because it's included in the standard installation)  
+If your have Windows XP or older, you need the Windows Resource Kit for your Windows version (RoboCopy is part of the Resource Kit).  
+Links to the downloads are on the bottom of the [Resource Kit's Wikipedia page](http://en.wikipedia.org/wiki/Windows_Resource_Kit).
+
+Windows PowerShell is part of all Windows versions since Windows XP SP2.  
+So if you have at least XP SP2, it should be there. If it's not, you can get it [here](http://www.microsoft.com/powershell).
+
+
+
+
+## How to build?
+
+RoboShell Backup itself doesn't need to be built, because it consists just of batch files and PowerShell scripts.  
+The only thing that needs to be compiled is the MSI setup.
+
+The setup is made using [WiX](http://wix.codeplex.com/).  
+To build it, you need the WiX Toolkit installed on your machine. At the moment, we're using WiX 3.5 which you can download [here](http://wix.codeplex.com/releases/view/60102).
+
+The build script is the file `Create Setup.bat` in the main folder of the repository, and it assumes that WiX is in your `%PATH%` variable.  
+In particular, the `bin` subfolder of the WiX installation path needs to be in your `%PATH%` variable, because the files used by the build script are located there.
 
 ### Acknowledgements