=================================================
                VersionCtrl 1.0
=================================================


Inhalt
--------

1. Lizenz
2. Prinzip
3. Anlegen eines Projektes
4. Unschnheiten Oberflche


1. Lizenz
-----------

MIT Lizenz

Copyright (c) 2018 Marius Otto

Hiermit wird unentgeltlich jeder Person, die 
eine Kopie der Software und der zugehrigen 
Dokumentationen (die "Software") erhlt, die 
Erlaubnis erteilt, sie uneingeschrnkt zu nutzen, 
inklusive und ohne Ausnahme mit dem Recht, sie zu 
verwenden, zu kopieren, zu verndern, 
zusammenzufgen, zu verffentlichen, zu 
verbreiten, zu unterlizenzieren und/oder zu 
verkaufen, und Personen, denen diese Software 
berlassen wird, diese Rechte zu verschaffen, 
unter den folgenden Bedingungen:

Der obige Urheberrechtsvermerk und dieser 
Erlaubnisvermerk sind in allen Kopien oder 
Teilkopien der Software beizulegen.

DIE SOFTWARE WIRD OHNE JEDE AUSDRCKLICHE ODER 
IMPLIZIERTE GARANTIE BEREITGESTELLT, 
EINSCHLIELICH DER GARANTIE ZUR BENUTZUNG FR 
DEN VORGESEHENEN ODER EINEM BESTIMMTEN ZWECK 
SOWIE JEGLICHER RECHTSVERLETZUNG, JEDOCH NICHT 
DARAUF BESCHRNKT. IN KEINEM FALL SIND DIE 
AUTOREN ODER COPYRIGHTINHABER FR JEGLICHEN 
SCHADEN ODER SONSTIGE ANSPRCHE HAFTBAR ZU 
MACHEN, OB INFOLGE DER ERFLLUNG EINES 
VERTRAGES, EINES DELIKTES ODER ANDERS IM 
ZUSAMMENHANG MIT DER SOFTWARE ODER SONSTIGER 
VERWENDUNG DER SOFTWARE ENTSTANDEN. 


2. Prinzip
------------

Das Grundprinzip von VersionCtrl dreht sich um
das Projekt. Ein Projekt ist eine Sammlung von 
Dateien und Ordnern. Jedes Projekt hat zu jedem
Zeitpunkt einen aktuellen Stand. Dieser Stand
wird in einer ZIP-Datei festgehalten. VersionCtrl
gibt nun die Mglichkeit, diesen Stand in ein 
anderes Verzeichnis zu entpacken. Werden die 
Inhalte dieses Verzeichnisses gendert, so 
entsteht eine ausstehende nderung, welche
innerhalb des beiliegenden Programms
"eingecheckt" (Sprich: In den aktuellen Stand
des Projektes bernommen) werden kann. Es
gibt zu jedem Zeitpunkt maximal einen 
entpackten Stand.


3. Anlegen eines Projektes
----------------------------

Um ein Projekt anlegen zu knnen, muss die
beiliegende VersionCtrl.exe gestartet werden.
Auf der linken Seite des sich ffnenden 
Fensters befindet sich der Projektexplorer. 
ber die Schaltflche "Add" unten links kann 
ein neues Projekt erstellt werden. In dem 
sich ffnenden Fenster muss der Projekt-
name und das entsprechende Grundverzeichnis,
von dem der aktuelle Stand in ein ZIP 
gepackt wird, angegeben werden. Mit einem
Klick auf "OK" wird das Projekt erstellt 
und es erscheint im Projektexplorer. 
Weiterhin wird ein neuer Ordner im Haupt-
verzeichnis des Programms namens "Projects"
erstellt, falls dieser noch nicht vorhanden
ist. In diesem Ordner enthalten sind weitere
Ordner, welche jeweils die Namen eines
Projekts haben. In diesen Ordnern befinden
sich alle Stnde des Projekts, wobei der
jngste Stand dem aktuellen Stand entspricht.
Im Programm kann nun ein sogenannter Branch
erstellt werden, sprich der aktuelle Stand
des Projekts wird an eine vom Benutzer 
festgelegte Stelle im Dateisystem entpackt.
Ist der Branch erstellt, knnen in dem ent-
packten Verzeichnis nderungen vorgenommen
werden, welche als "Pending Changes" im 
Programm aufgefhrt sind. Sind alle 
nderungen erfolgt, kann der Stand des
entpackten Verzeichnisses ber die 
Schaltflche "Check-In" in den aktuellen
Projektstand bernommen werden.


4. Unschnheiten Oberflche
-----------------------------

-> Die englische bersetzung ist mau
-> Die Benutzerfhrung ist etwas "hakelig"
-> Nach einem Programmneustart werden offene
   nderungen nicht mehr angezeigt und der 
   Check-In kann nicht erfolgen. Workaround
   ist die temporre nderung einer Datei 
   nach dem Programmneustart, um die 
   Schaltflche "Check-In" wieder bedienbar
   zu machen

