Merge pull request 52623 from prepare_first_release into master

Last touch-ups for first release

Install.md

@@ -0,0 +1,42 @@
+Installation Instructions
+=========================
+This document explains where to copy the JAR and how to configure Git to use the "Microsoft Git Credential Manager for Java" as its credential helper. 
+
+System Requirements
+-------------------
+Great care was taken to avoid using any features of Java that would impact compatibility with Java 6.  If you find a compatibility issue, please report it.
+1. Java 6+
+2. Git 1.9+
+
+How to install
+--------------
+1. Copy the `git-credential-helper-0.1.0.jar` file somewhere safe and stable, such as `%APPDATA%/git-credential-helper/` on Windows or `~/Library/Application Support/git-credential-helper/` on Mac or `~/git-credential-helper/` on Linux.
+2. Configure the `credential.helper` setting to launch Java with the path to the JAR (make sure you surround the whole value with 'single quotes' in Bash and "double quotes" in the Windows Command Prompt):
+
+```git config --global credential.helper '!java -jar path/to/git-credential-helper-0.1.0.jar'``` 
+
+How to enable (or disable) debug mode
+-------------------------------------
+This will turn on tracing and assertions, producing a lot of output to `stderr`.  Only turn this on temporarily, when trying to isolate a defect.
+1. Retrieve the value of the `credential.helper` configuration:
+
+ ```git config --global --get credential.helper```
+
+ ...it should look like this:
+
+ ```!java -jar path/to/git-credential-helper-0.1.0.jar```
+2. Set a new value for the `credential.helper` configuration by inserting `-Ddebug=true` (or `-Ddebug=false` to disable) between `!java` and `-jar` (make sure you surround the whole value with 'single quotes' in Bash and "double quotes" in the Windows Command Prompt):
+
+```git config --global credential.helper '!java -Ddebug=true -jar path/to/git-credential-helper-0.1.0.jar'```
+
+How to remove or uninstall
+--------------------------
+We are sad to see you go!  Please give us some feedback on how we could do better next time.
+1. Retrieve the value of the `credential.helper` configuration:
+
+ ```git config --global --get credential.helper```
+2. Delete the value of the `credential.helper` configuration:
+
+ ```git config --global --unset credential.helper```
+3. The value retrieved in _step 1_ contained the path to the JAR.  You can go delete that JAR.
+4. Archive the `insecureStore.xml` file from your HOME folder. 

ReleaseNotes.md

@@ -0,0 +1,7 @@
+Release Notes
+=============
+Every release is described here, from latest to earliest.
+
+Version 0.1.0
+-------------
+Initial release of C# port which supports Basic authority only and a plain-text credential store (`~/insecureStore.xml`) making it equivalent to the built-in git-credential-store.

pom.xml

@@ -52,6 +52,18 @@ Licensed under the MIT license. See License.txt in the project root. -->
   </properties>
 
   <build>
+    <resources>
+      <resource>
+        <directory>${basedir}</directory>
+        <targetPath>./</targetPath>
+        <includes>
+          <include>Install.md</include>
+          <include>License.txt</include>
+          <include>ReadMe.md</include>
+          <include>ReleaseNotes.md</include>
+        </includes>
+      </resource>
+    </resources>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -106,7 +118,7 @@ Licensed under the MIT license. See License.txt in the project root. -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
-        <version>2.16</version>
+        <version>2.15</version>
         <executions>
           <execution>
             <id>verify-style</id>