Merge branch 'release/1.0.0'

.gitignore

@@ -1,23 +1,117 @@
-# Object files
-*.o
-*.ko
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# User-specific files
+*.suo
+*.user
+*.sln.docstates
+
+# Build results
+[Bb]in/
+[Cc]lientbin/
+[Dd]ebug/
+[Rr]elease/
+[Oo]utput*/
+[Pp]ackages*/
+bin
+obj
+[Ll]ib/
+*_i.c
+*_p.c
+*.ilk
+*.meta
 *.obj
-*.elf
-
-# Libraries
-*.lib
-*.a
-
-# Shared objects (inc. Windows DLLs)
-*.dll
-*.so
-*.so.*
-*.dylib
-
-# Executables
-*.exe
-*.out
-*.app
-*.i*86
-*.x86_64
-*.hex
+*.orig
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.vspscc
+*.xap
+.builds
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+
+# Visual Studio profiler
+*.psess
+*.vsp
+
+# ReSharper is a .NET coding add-in
+_ReSharper*
+*.resharper.user
+
+# Catel
+CatelLogging.txt
+
+# Dotcover
+*.dotCover
+*.dotsettings.user
+
+# Finalbuilder
+*.fbl7
+*.fb7lck
+*.fbpInf
+
+# Ghostdoc
+*.GhostDoc.xml
+
+# Deployments
+deployment/FinalBuilder/backup
+deployment/InnoSetup/template/templates
+deployment/InnoSetup/template/snippets
+deployment/InnoSetup/template/libraries
+deployment/InnoSetup/template/doc
+
+# Installshield output folder 
+[Ee]xpress
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish
+
+# Others
+[Bb]in
+[Oo]bj
+sql
+TestResults
+*.Cache
+ClientBin
+stylecop.*
+~$*
+*.dbmdl
+Generated_Code #added for RIA/Silverlight projects
+
+# Backup & report files from converting an old project file to a newer
+# Visual Studio version. Backup files are not needed, because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+
+# Windows image file caches
+Thumbs.db 
+
+# Folder config file
+Desktop.ini
+
+# mstest test results
+TestResults

README.md

@@ -1,4 +1,70 @@
 GitHubLink
 ==========
 
-Let users step through your code hosted on GitHub!
+![GitHubLink](design/logo/logo_64.png)
+
+GitHubLink let's users step through your code hosted on GitHub! **This makes symbol servers obsolete** which saves you both time with uploading source files with symbols and the user no longer has to specify custom symbol servers (such as symbolsource.org).
+
+![Stepping through external source code](doc/images/GitHubLink_example.gif)  
+
+The idea is based on the [SourceLink project](https://github.com/ctaggart/SourceLink "SourceLink project"). However it requires FAKE and no everyone likes to write code in F#. GitHubLink is available as console application and can be references as assembly as well to be used in other .NET assemblies.
+
+The advantage of GitHubLink is that it is fully customized for GitHub. It also works with GitHub urls so it **does not require a local git repository to work**. This makes it perfectly usable in continuous integration servers such as [Continua CI](http://www.finalbuilder.com/Continua-CI "Continua CI").
+
+Updating all the pdb files is very fast. A solution with over 85 projects will be handled in less than 30 seconds.
+
+When using GitHubLink, the user no longer has to specify symbol servers. He/she only has to enable the support for source servers in Visual Studio as shown in the image below:
+
+![Enabling source server support](doc/images/visualstudio_enablesourceserversupport.png)  
+
+# Using GitHubLink #
+
+Using GitHubLink is very simple:
+
+1. Build the software (in release mode with pdb files enabled)
+2. Run the console application with the right command line parameters
+
+Below are a few examples.
+
+## Running for the default branch ##
+
+    GitHubLink.exe c:\source\catel -u https://github.com/catel/catel 
+
+This will use the default branch (which is in most cases **master**). You can find out the default branch by checking what branch is loaded by default on the GitHub page.
+
+## Running for a specific branch ##
+
+    GitHubLink.exe c:\source\catel -u https://github.com/catel/catel -b develop
+
+This will use the develop branch.
+
+## Running for a specific branch and configuration ##
+
+    GitHubLink.exe c:\source\catel -u https://github.com/catel/catel -b develop -c debug
+
+This will use the develop branch and the debug configuration.
+
+## Getting help ##
+
+When you need help about GitHubLink, use the following command line:
+
+    GitHubLink.exe -help
+
+## Logging to a file ##
+
+When you need to log the information to a file, use the following command line:
+
+    GitHubLink.exe c:\source\catel -u https://github.com/catel/catel -b develop -l GitHubLinkLog.log
+
+
+# How does it work #
+
+The SrcSrv tool (Srcsrv.dll) enables a client to retrieve the exact version of the source files that were used to build an application. Because the source code for a module can change between versions and over the course of years, it is important to look at the source code as it existed when the version of the module in question was built.
+
+For more information, see the [official documentation of SrcSrv](http://msdn.microsoft.com/en-us/library/windows/hardware/ff558791(v=vs.85).aspx).
+
+GitHubLink creates a source index file and updates the PDB file so it will retrieve the files from the GitHub file handler.
+
+# Icon #
+
+Link by Dominic Whittle from The Noun Project

deployment/NuGet/template/GitHubLink.nuspec

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package>
+  <metadata>
+    <id>GitHubLink</id>
+    <version>[VERSION]</version>
+	<title>GitHubLink</title>
+    <authors>GeertvanHorrik</authors>
+
+	<description>
+	  GitHubLink let's users step through your code hosted on GitHub! This makes symbol servers obsolete which saves you both time 
+      with uploading source files with symbols and the user no longer has to specify custom symbol servers (such as symbolsource.org).
+	</description>
+
+	<summary>
+	</summary>
+
+	<tags>source symbol symbols server sourcelink github stepping debugging</tags>
+
+	<language>en-US</language>
+	<projectUrl>https://github.com/GeertvanHorrik/GitHubLink/</projectUrl>	
+	<licenseUrl>https://github.com/GeertvanHorrik/GitHubLink/blob/develop/LICENSE</licenseUrl>
+	<iconUrl>https://raw.githubusercontent.com/GeertvanHorrik/GitHubLink/develop/design/logo/logo_64.png</iconUrl>
+  </metadata>
+</package>

design/logo/Link/license.txt

@@ -0,0 +1,8 @@
+Thank you for using The Noun Project. This icon is licensed under Creative
+Commons Attribution and must be attributed as:
+
+    Link by Dominic Whittle from The Noun Project
+
+If you have a Premium Account or have purchased a license for this icon, you
+don't need to worry about attribution! We will share the profits from your
+purchase with this icon's designer.

doc/history.txt

@@ -0,0 +1,35 @@
+GitHubLink history
+==================
+
+(+) Added
+(*) Changed
+(-) Removed
+(x) Error / bug (fix)
+
+For more information about issues or new feature requests, please visit:
+
+Project website: https://github.com/GeertvanHorrik/GitHubLink
+
+**********************************************************
+
+==================
+Version 1.0.0
+==================
+
+Release date:
+=============
+2014/xx/xx
+
+Added/fixed:
+============
+xxx
+
+Roadmap:
+========
+See https://github.com/GeertvanHorrik/GitHubLink
+
+Known issues:
+=============
+See https://github.com/GeertvanHorrik/GitHubLink
+
+**********************************************************

lib/RestorePackages.bat

@@ -0,0 +1,4 @@
+for /f %%a IN ('dir /b ..\src\*.sln') do call ..\tools\nuget\nuget.exe restore ..\src\%%a -PackagesDirectory .\
+
+
+pause

lib/repositories.config

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<repositories>
+  <repository path="..\src\GitHubLink.Test\packages.config" />
+  <repository path="..\src\GitHubLink\packages.config" />
+</repositories>