Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
Added a README.
  • Loading branch information
rhymeswithmogul committed Apr 10, 2019
1 parent 3587f81 commit ce48084
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <a href="https://git.samba.org/?p=rsync.git"><tt>rsync</tt></a> 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!

0 comments on commit ce48084

Please sign in to comment.