Skip to content

Commit

Permalink
Improve Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
guenhter committed Jun 25, 2024
1 parent 45adfc6 commit d5624ce
Showing 1 changed file with 24 additions and 13 deletions.
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,48 @@
# Simple Folder Syncer

The
The Simple Folder Syncer is a thin wrapper around the Windows program "Robocopy". Robocopy is used
to mirror one folder to another. The reason for this wrapper is to make the exclude handling
a little bit easier and narrow the program down to only syncing folders.


## Limitations

* Currently only Windows is supported


## Prerequisites

* Robocopy (should acutally be available on every Windows machine)



## Development Notes

A MSI file is produced to make it easier installable.

### MSI Prerequisites
To build a new MSI, the following tools are needed

This project uses the Windows Installer XML (WiX) Toolset for building MSI packages.
The following tools are needed:

* .Net SDK (https://learn.microsoft.com/en-us/dotnet/core/install/windows)
* Wix Tools (https://wixtoolset.org/docs/intro/#msbuild)
* WiX Tools (https://wixtoolset.org/docs/intro/#msbuild)

The tools can be installed with

```ps1
```powershell
# Install .Net
winget install Microsoft.DotNet.SDK.8
# Install Wix
# Install WiX
dotnet tool install --global wix
```


## Useful Commands
Please note, that the cardo-wix plugin is not used because it is still besed
on WiX 3. The used WiX version of this project is the latest WiX 5.

### Create a new MSI


```ps1
cargo wix
```


```ps1
# Building the MSI
wix build .\package.wxs -o my.msi -arch x64
Expand Down

0 comments on commit d5624ce

Please sign in to comment.