Skip to content

Commit fd113bb

Browse files
authored
README updated with 1.1 changes and Core library
1 parent 9cd00ad commit fd113bb

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# SimpleFileBackup
22
Simple C# program for copying multiple files to multiple locations at once
33

4-
![Image of SimpleFileBackup UI](https://i.imgur.com/8520Ob0.png)
4+
![SimpleFileBackup Windows UI](https://user-images.githubusercontent.com/18032233/181794403-6569fb36-1690-4342-8b1c-10d5d1243175.PNG)
55

66
## Download
77
https://github.com/malthee/SimpleFileBackup/releases
88

9+
# SimpleFileBackup.Windows
910
## General
10-
Select files by pressing the first "Browse" button on the right. You can select multiple files at once or open the browse window multiple times. After pressing OK the file locations will be saved in the drop down list. You can also add files by typing the path in the textbox and pressing enter. If you made a wrong selection, you can delete single items by selecting them in the drop down list and pressing "Delete Item". You can clear the list by pressing "Clear List".
11+
Select files or folders by pressing the Select buttons on the right. You can select multiple files or folders at once. After pressing OK the file locations will be saved in the drop down list. You can also add files by typing the path in the textbox and pressing enter. If you made a wrong selection, you can delete single items by selecting them in the drop down list and pressing "Delete Item". You can clear the list by pressing "Clear List".
1112

12-
The "Backup Destitination" selection works the same way.
13+
Backup Destinations can be selected through the same process. Every file or folder in "Files to Backup" will be backed up to every "Backup Destination".
1314

1415
## Settings
1516

@@ -19,8 +20,6 @@ If you want to replace your old files with the new files enable the "Override id
1920
### Put files in given directory
2021
Copies the files into the selected directories.
2122

22-
![List of files](https://i.imgur.com/6DghufZ.png)
23-
2423
### Create a subfolder in directory
2524
Creates a subfolder in every given directory.
2625

@@ -34,11 +33,29 @@ You can name your folder or .zip file with a maximum of 20 characters. The chara
3433
### Add date to Folder/.zip name
3534
Adds your local date to the folder/.zip name in the format name_10-10-2010.
3635

37-
### Save Default File Paths & Save Default Backup Paths
38-
Saves your file/backup locations as a list in a text file, that is located in the program folder. This list is loaded when the program is launched and inserted in the drop down list.
36+
### Save Defaults
37+
Saves your file/backup locations and settings to keep them for the next program start.
3938

4039
### Save Custom File Paths & Save Custom Backup Paths
4140
Saves your file/backup locations in a text file you can choose the location of.
4241

4342
### Open File Paths & Open Backup Paths
4443
You can open a text file that contains paths to files or directories. These paths will be inserted into the drop down list.
44+
45+
# SimpleFileBackup.Core
46+
Core is a `.NET Framework 2.0` library for persisting one or more files or folders in one or more other locations in any recoverable format. As an example it can be used to copy files and folders from different drive locations to multiple backup drives at once.
47+
48+
An overview of the components can be seen in the following diagram:
49+
![Class Diagram of SFB Core](Doc/CoreClassDiagram.drawio.svg)
50+
51+
## Public interface
52+
* `BackupWriterFactory`: provides implementations of `IBackupWriter`
53+
* `IBackupWriter`: contract every backup writer has to implement. Used to start a backup with or without cancellation and progress reporting.
54+
* `BackupArguments`: used to create a `BackupWriterFactory`. Contains input and output information.
55+
* `BackupMetadataInfo`: can be created with `BackupArguments`. Contains information about file size and count which is handled.
56+
* `IBackupProgress` and `BackupProgress`: extended Interface with `BackupMetadataInfo` for progress calculation and adapter implementation of `Progress<T>`.
57+
* `BackupProgressInfo`: provides the user with information how far the backup is in percent and how many bytes have been written to output locations.
58+
59+
## Contribute
60+
Feature requests and bugs must have a ticket and description before any pull request is accepted. There is also a Project board on GitHub in which some current feature requests are prioritized and documented.
61+
Otherwise any contributers are welcome!

0 commit comments

Comments
 (0)