Skip to content
This repository was archived by the owner on Feb 12, 2023. It is now read-only.

Commit e959537

Browse files
GeertvanHorrikGeertvanHorrik
committed
Merge branch 'release/1.0.0'
2 parents d773374 + 6c51f98 commit e959537

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+2802
-23
lines changed

‎.gitignore

Lines changed: 116 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,117 @@
1-
# Object files
2-
*.o
3-
*.ko
1+
## Ignore Visual Studio temporary files, build results, and
2+
## files generated by popular Visual Studio add-ons.
3+
4+
# User-specific files
5+
*.suo
6+
*.user
7+
*.sln.docstates
8+
9+
# Build results
10+
[Bb]in/
11+
[Cc]lientbin/
12+
[Dd]ebug/
13+
[Rr]elease/
14+
[Oo]utput*/
15+
[Pp]ackages*/
16+
bin
17+
obj
18+
[Ll]ib/
19+
*_i.c
20+
*_p.c
21+
*.ilk
22+
*.meta
423
*.obj
5-
*.elf
6-
7-
# Libraries
8-
*.lib
9-
*.a
10-
11-
# Shared objects (inc. Windows DLLs)
12-
*.dll
13-
*.so
14-
*.so.*
15-
*.dylib
16-
17-
# Executables
18-
*.exe
19-
*.out
20-
*.app
21-
*.i*86
22-
*.x86_64
23-
*.hex
24+
*.orig
25+
*.pch
26+
*.pdb
27+
*.pgc
28+
*.pgd
29+
*.rsp
30+
*.sbr
31+
*.tlb
32+
*.tli
33+
*.tlh
34+
*.tmp
35+
*.vspscc
36+
*.xap
37+
.builds
38+
39+
# Visual C++ cache files
40+
ipch/
41+
*.aps
42+
*.ncb
43+
*.opensdf
44+
*.sdf
45+
46+
# Visual Studio profiler
47+
*.psess
48+
*.vsp
49+
50+
# ReSharper is a .NET coding add-in
51+
_ReSharper*
52+
*.resharper.user
53+
54+
# Catel
55+
CatelLogging.txt
56+
57+
# Dotcover
58+
*.dotCover
59+
*.dotsettings.user
60+
61+
# Finalbuilder
62+
*.fbl7
63+
*.fb7lck
64+
*.fbpInf
65+
66+
# Ghostdoc
67+
*.GhostDoc.xml
68+
69+
# Deployments
70+
deployment/FinalBuilder/backup
71+
deployment/InnoSetup/template/templates
72+
deployment/InnoSetup/template/snippets
73+
deployment/InnoSetup/template/libraries
74+
deployment/InnoSetup/template/doc
75+
76+
# Installshield output folder
77+
[Ee]xpress
78+
79+
# DocProject is a documentation generator add-in
80+
DocProject/buildhelp/
81+
DocProject/Help/*.HxT
82+
DocProject/Help/*.HxC
83+
DocProject/Help/*.hhc
84+
DocProject/Help/*.hhk
85+
DocProject/Help/*.hhp
86+
DocProject/Help/Html2
87+
DocProject/Help/html
88+
89+
# Click-Once directory
90+
publish
91+
92+
# Others
93+
[Bb]in
94+
[Oo]bj
95+
sql
96+
TestResults
97+
*.Cache
98+
ClientBin
99+
stylecop.*
100+
~$*
101+
*.dbmdl
102+
Generated_Code #added for RIA/Silverlight projects
103+
104+
# Backup & report files from converting an old project file to a newer
105+
# Visual Studio version. Backup files are not needed, because we have git ;-)
106+
_UpgradeReport_Files/
107+
Backup*/
108+
UpgradeLog*.XML
109+
110+
# Windows image file caches
111+
Thumbs.db
112+
113+
# Folder config file
114+
Desktop.ini
115+
116+
# mstest test results
117+
TestResults

‎README.md

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,70 @@
11
GitHubLink
22
==========
33

4-
Let users step through your code hosted on GitHub!
4+
![GitHubLink](design/logo/logo_64.png)
5+
6+
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).
7+
8+
![Stepping through external source code](doc/images/GitHubLink_example.gif)
9+
10+
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.
11+
12+
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").
13+
14+
Updating all the pdb files is very fast. A solution with over 85 projects will be handled in less than 30 seconds.
15+
16+
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:
17+
18+
![Enabling source server support](doc/images/visualstudio_enablesourceserversupport.png)
19+
20+
# Using GitHubLink #
21+
22+
Using GitHubLink is very simple:
23+
24+
1. Build the software (in release mode with pdb files enabled)
25+
2. Run the console application with the right command line parameters
26+
27+
Below are a few examples.
28+
29+
## Running for the default branch ##
30+
31+
GitHubLink.exe c:\source\catel -u https://github.com/catel/catel
32+
33+
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.
34+
35+
## Running for a specific branch ##
36+
37+
GitHubLink.exe c:\source\catel -u https://github.com/catel/catel -b develop
38+
39+
This will use the develop branch.
40+
41+
## Running for a specific branch and configuration ##
42+
43+
GitHubLink.exe c:\source\catel -u https://github.com/catel/catel -b develop -c debug
44+
45+
This will use the develop branch and the debug configuration.
46+
47+
## Getting help ##
48+
49+
When you need help about GitHubLink, use the following command line:
50+
51+
GitHubLink.exe -help
52+
53+
## Logging to a file ##
54+
55+
When you need to log the information to a file, use the following command line:
56+
57+
GitHubLink.exe c:\source\catel -u https://github.com/catel/catel -b develop -l GitHubLinkLog.log
58+
59+
60+
# How does it work #
61+
62+
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.
63+
64+
For more information, see the [official documentation of SrcSrv](http://msdn.microsoft.com/en-us/library/windows/hardware/ff558791(v=vs.85).aspx).
65+
66+
GitHubLink creates a source index file and updates the PDB file so it will retrieve the files from the GitHub file handler.
67+
68+
# Icon #
69+
70+
Link by Dominic Whittle from The Noun Project

‎deployment/NuGet/template/GitHubLink.nuspec

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<package>
3+
<metadata>
4+
<id>GitHubLink</id>
5+
<version>[VERSION]</version>
6+
<title>GitHubLink</title>
7+
<authors>GeertvanHorrik</authors>
8+
9+
<description>
10+
GitHubLink let's users step through your code hosted on GitHub! This makes symbol servers obsolete which saves you both time
11+
with uploading source files with symbols and the user no longer has to specify custom symbol servers (such as symbolsource.org).
12+
</description>
13+
14+
<summary>
15+
</summary>
16+
17+
<tags>source symbol symbols server sourcelink github stepping debugging</tags>
18+
19+
<language>en-US</language>
20+
<projectUrl>https://github.com/GeertvanHorrik/GitHubLink/</projectUrl>
21+
<licenseUrl>https://github.com/GeertvanHorrik/GitHubLink/blob/develop/LICENSE</licenseUrl>
22+
<iconUrl>https://raw.githubusercontent.com/GeertvanHorrik/GitHubLink/develop/design/logo/logo_64.png</iconUrl>
23+
</metadata>
24+
</package>

‎design/logo/Link/icon_15341.png

32.2 KB
Loading

‎design/logo/Link/icon_15341.svg

Lines changed: 8 additions & 0 deletions
Loading

‎design/logo/Link/license.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Thank you for using The Noun Project. This icon is licensed under Creative
2+
Commons Attribution and must be attributed as:
3+
4+
Link by Dominic Whittle from The Noun Project
5+
6+
If you have a Premium Account or have purchased a license for this icon, you
7+
don't need to worry about attribution! We will share the profits from your
8+
purchase with this icon's designer.

‎design/logo/logo.ico

361 KB
Binary file not shown.

‎design/logo/logo_1024.png

28.9 KB
Loading

‎design/logo/logo_128.png

2.82 KB
Loading

‎design/logo/logo_16.png

380 Bytes
Loading

0 commit comments

Comments
 (0)