From ce4808450c607400a6a26d4400a20ba3b99272eb Mon Sep 17 00:00:00 2001 From: Colin Cogle Date: Tue, 9 Apr 2019 23:28:11 -0400 Subject: [PATCH] Create README.md Added a README. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4bcbab6 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# PSTimeMachine +One day, I was so mad at a backup vendor *and* at Windows Server Backup, that I wrote my own simple backup tool in PowerShell. + +Apple's Time Machine and rsync were the inspirations for this: +* **Versioned:** Every time the tool runs, a new folder tree is created. +* **Secure:** Old backups are never modified by this tool. +* **Simple:** It creates entire, browseable folder trees at the destination that require no tools to restore from. +* **Efficient:** Only changed files are copied from the source to the destination; unchanged files are added with filesystem-level hard links. + +## Requirements +1. The system must be running PowerShell Core or at least Windows PowerShell 5. +2. Ideally, your backup destination should support hard links. If not, backups will use a *lot* of space. + +## How to Use It +Like this: + + .\PSTimeMachine.ps1 -SourcePath C:\Shares\SomeShare -DestinationPath D:\BackupsOfSomeShare + +For help: + + Get-Help .\PSTimeMachine.ps1 + +## Contributing +Please do!