From eqqon

Revision as of 18:54, 13 June 2009 (view source) Henon (Talk | contribs) m ← Older edit		Latest revision as of 20:44, 26 May 2011 (view source) Henon (Talk | contribs) m (→Status of the Project)
(254 intermediate revisions not shown)
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
-		+	[[Category:CSharp]]
	<div style="float:right;margin:10px;">		<div style="float:right;margin:10px;">
-	<div style="width:500px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">	+	<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
-	<big><big>Agreed, git support on Windows could be better ...</big></big>	+	[[Image:Gitsharp.png|150px|right]]
-	<h1> ... want to improve the situation?</h1>	+	'''[http://github.com/downloads/henon/GitSharp/GitSharp-0.3.0.056f5345c8835fabc1a8f90548a9c5b0abdf9a68-release-net-3.5.zip Download]''' the latest binary release.
		+	=== Releases ===
		+	* [[/v0.3.0| GitSharp 0.3]]
		+	* [[/v0.2.0| GitSharp 0.2]]
		+	* [[/v0.1.3| GitSharp 0.1.3]]
		+	* [[/v0.1.0| GitSharp 0.1]]
		+	</div>
-	<br>Contribute to <big><big><big>Git#</big></big></big> for C#, the most advanced open source implementation of git for .NET	+	<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
-	<br>Every little bit helps:	+	=== Documentation ===
-	* Link to the [http://www.eqqon.com/index.php/GitSharp dotgit website] to promote the project.	+	* [http://henon.github.com/GitSharp/ GitSharp online API documentation]
-	* Tell your friends ...	+	* [[/Examples]] ... a collection of code samples demonstrating the intuitive API.
-	* Code! Tackle one of the missing features or add unit tests.	+	* [[/Compatibility]] of git# with respect to original git, .NET and Mono
		+	* [[/Dependencies]] ... a list of included open source components and tools
		+	* [[/Contributing]] to gitsharp. Everything you need to know to get started.
-	<br>So let's all stop complaining about the situation, start rocking and have fun!	+	;Developer Docs
		+	* [[Image:Git_Index_Diagrams_by_Rolenun.pdf|Git Index Diagrams]] <small>(Beware: IE may freeze)</small>
	</div>		</div>
-	<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;margin-top:200px;">	+
		+
		+	<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
	'''What is Git?'''		'''What is Git?'''
Line 24:		Line 35:
	Git is used for version control of files, much like tools such as Mercurial, Bazaar, Subversion, CVS, Perforce, and Visual SourceSafe.		Git is used for version control of files, much like tools such as Mercurial, Bazaar, Subversion, CVS, Perforce, and Visual SourceSafe.
		+
		+	Git's key characteristics make it stand out against the other SCM tools:
		+	* Strong and efficient support for non-linear development
		+	* Distributed development
		+	* Multiple protocol support such as HTTP, FTP, ssh, rsync, etc.
		+	* Efficient handling of large projects
		+	* Pluggable merge strategy
		+
		+	<br>
		+	'''Popularity'''
		+
		+	According to [http://git.or.cz/gitwiki/GitSurvey2008 a survey by the git community] it is rapidly gaining more users. A graph of the survey results clearly demonstrates the trend.
		+
		+	[[Image:Git survey responses (1) thumb-2-.png]]<br>
		+	<small>(borrowed from [http://bugsquash.blogspot.com/ Mauricio Scheffer])</small>
	</div>		</div>
		+
		+
		+
		+	<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
		+
		+	=== News ===
		+	* October 28th: gitsharp 0.2 released.
		+	* October 11th: gitsharp 0.1.3 released.
		+	* October 8th: gitsharp 0.1.2 tagged.
		+	* September 26th: First release (version 0.1.0).
		+	* September 22th: We got a [https://spreadsheets.google.com/ccc?key=tqdArp3Ob2ZUADD54xD6oLw&hl=en collaboration space] where you can see the porting progress and who is working on what.
		+	* September 19th: Rolenun significantly improved the command line interface. Caytchen implemented the Commands "git init" and "git clone".
		+	* August 25th, 2009: Jim Radford added git# at his [http://tc.openmv.org/project.html?projectId=project11 TeamCity integration server]. We now have automatic builds on both, Windows and Mono. Since the other TeamCity account does not support Mono it can now be viewed as a code mirror ;)
		+	* August 15th, 2009: Dan Rigby created the IRC channel #GitSharp on freenode. It's a nice place to chat a little or ask questions about git.
		+	* July 2nd, 2009: Mauricio Scheffer has set up git# on the build and integration service [http://teamcity.codebetter.com/project.html?projectId=project44 teamcity.codebetter.com]
		+	* July 1st, 2009: Writing of blobs, trees and commits works
		+	* June 15th, 2009: Reading of commit history, trees, blobs and tags works. See the demo browser screenshot below.
	</div>		</div>
-	= Git# --> Git for .NET =	+	<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
		+	=== Public Echo ===
		+	Most recent first:
		+	* [http://www.chodounsky.net/bonobo-git-server/bonobo-git-serverscreenshots/ Jakub Chodounsky created Bonobo Git Server]
		+	* [https://build.opensuse.org/package/show?package=gitsharp&project=home:nestalk Nestalk packaged gitsharp for Suse]
		+	* [http://www.h-online.com/open/news/item/MonoDevelop-2-4-released-1024208.html MonoDevelop determined to build on GitSharp for git support]
		+	* [http://bugsquash.blogspot.com/2009/10/git-filter-branch-with-gitsharp.html Mauricio Scheffer shows how to use GitSharp for correcting history]
		+	* [http://www.linux.org.ru/view-message.jsp?msgid=4130789 Russian Linux magazine reports release of GitSharp] (Russian)
		+	* [http://codezine.jp/article/detail/4497 Japanese online magazine reports release of GitSharp] (Japanese)
		+	* [http://www.heise.de/ix/meldung/GitSharp-Versionskontrollsystem-nach-C-portiert-823311.html German IT magazine reports release of gitsharp] (German)
		+	* [http://www.infoq.com/news/2009/10/Git-Sharp InfoQ reports release of gitsharp]
		+	* [http://osss.cn/news/2009/10/13/gitsharp-%E9%A6%96%E6%AC%A1%E5%85%AC%E5%BC%80%E5%8F%91%E8%A1%8C/ Report about release of gitsharp on OSSS.cn] (Chinese)
		+	* [http://www.h-online.com/open/First-public-release-of-GitSharp-arrives--/news/114453 The H reports release of gitsharp]
		+	* [http://tirania.org/blog/archive/2009/Oct-12.html Miguel de Icaza writes a nice blog entry about our release] His post triggers reports all over the world.
		+	* [http://www.linux-magazine.com/Online/News/GitSharp-Project-Working-Toward-Better-Git-for-Windows Report on Linux magazine about GitSharp]
		+	* [http://tirania.org/blog/archive/2009/Sep-01-1.html Miguel de Icaza blogs about GitSharp's progress]
		+
		+	</div>
		+
		+
		+
		+	</div>
		+
		+	= GitSharp - Git for .NET and Mono =
	<big><big>... a native Windows version of the fast & free open source version control system</big></big>		<big><big>... a native Windows version of the fast & free open source version control system</big></big>
	<br>		<br>
-	'''Git#''' is the most advanced of all emerging C# implementations of git for Windows and the .NET framework. It is aimed to be fully compatible to the original git for linux and can be used as library for windows applications such as gui frontends or plugins for IDEs.	+	'''GitSharp''' is an implementation of [http://git-scm.com/ Git] for the Dot.Net Framework and Mono. It is aimed to be fully compatible to the original Git and shall be a light weight library for cool applications that are based on Git as their object database or are reading or manipulating repositories in some way.
-	== What you can do with Git#  ==	+	<br>
-	;Git# as object oriented interface to your git repo	+	Navigation: [http://github.com/henon/GitSharp/downloads Downloads] | [http://github.com/henon/GitSharp Sources] | [http://henon.github.com/GitSharp/ API Docs] | [http://code.google.com/p/gitsharp/issues/list Bugs & Issues] | [http://tc.openmv.org/project.html?projectId=project11 Integration Server] | [http://groups.google.com/group/gitsharp/ Mailing List] | [http://github.com/henon/GitSharp.Demo GitSharp.Demo]
-	:Want to manipulate you git repo from C#? Want to calculate statistics or create a beautiful visualization? Use dotgit's well designed object oriented API to access git repositories.	+
-	;Git# as replacement of msysgit	+	== Status of the Project ==
-	:Well, this is our ultimate goal, but we are not yet there. Please help making this vision come true by contributing to the project.	+	GitSharp is a quite usable and stable library used by several projects to interact with git repositories. To get an idea check out the Demo (see below)! GitSharp development is currently on hold because we believe that the libgit2 project and its C# bindings [https://github.com/libgit2/libgit2sharp/wiki libgit2sharp] are far more promising to work on.
-	;Git# as object database	+	;Modules:
-	:Git is an object database with built-in history and branching. If you need to create snapshots of your application's configuration or your user's data with alternative configuration branches then use git. By moving the HEAD in the repository you can easily implement undo/redo operations. For instance, one could build a wiki on top of dotgit or a distributed content management system. (We need to implement write-support for this.)	+	* '''GitSharp.Core''' - a manual line by line port of jgit (outdated)
		+	* '''GitSharp.CLI''' (git.exe) - quite incomplete
		+	* '''GitSharp''' - a user friendly api designed to be easier to use and learn than GitSharp.Core
-	;Git# as (distributed) file system	+	== Projects using GitSharp ==
-	:Git has been designed by Linus Thorwalds to be a file system that is very good at content-tracking and keeping multiple distributed versions of the same content in sync. If your application needs to implement backup and/or content synchronization routines then it can build on top of git to do that.  (We need to implement write-support and remote support for this.)	+	=== Bonobo Git Server ===
		+	Jakub Chodounský created [http://www.chodounsky.net/bonobo-git-server Bonobo Git Server] for
		+	Windows (Git application server hosted on IIS with many features - based on the gitsharp library.
-	;Git# as peer-to-peer content distribution system
-	:If you need to build a content distribution framework that will easily and efficiently transport content to different machines then you can easily build one on top of git.  (We need to implement write-support and remote support for this.)
-	== Status of the Project ==	+	=== GitSharp.Demo ===
-	;Development Status: Pre-Alpha	+	[http://github.com/henon/GitSharp.Demo GitSharp.Demo] is a small repository browser project that demonstrates the use of the GitSharp library and the user oriented API.
-	;TODO list the tests here that are working and those that fail and those that are not yet ported	+	The source demonstrates how easy it is to ...
		+	* open and interact with a git repository
		+	* iterate over the file-tree of a specific revision
		+	* get the contents of a single file of a specific revision
		+	* get the changes between two commits
		+	* display a modification as text diff
		+
		+	[[Image:2010.01.31 gitsharp.demo.png|200px]]
		+
		+	=== TicGit.net ===
		+	[[TicGit.net]] a small distributed issue tracker that uses git to keep track of tickets. It demonstrates the use of gitsharp's commiting API. TicGit is a toy project inspired by Scott Chacon's ruby application "ticgit".
		+
		+	[[Image:TicGit_Screenshot1.png|200px]]
-	== Get the Source Code ==
	== License ==		== License ==
		+	Git# is derived from the Java library [http://www.eclipse.org/jgit jgit] and is released under the same BSD license as jgit.
		+
		+	Please refer to the LICENSE.txt files for the complete license, and please refer to the individual source file
		+	header to determine which license covers it and who contributed and therefor holds copyrights to the files.
		+
		+	<div style="width:600px;margin:20px;">
		+	'''Copyright (C) 2007-2009, The Git Development Community and the GitSharp Team'''
		+	See source file headers for specific copyrights of contributors
		+
		+	<br><br>
		+
		+	All rights reserved.
		+	<br><br>
		+
		+	Redistribution and use in source and binary forms, with or
		+	without modification, are permitted provided that the following
		+	conditions are met:
		+	<br><br>
		+
		+	* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
		+	* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
		+	* Neither the name of the Git Development Community nor the GitSharp Team nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
		+	<br>
		+
		+	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
		+	CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
		+	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
		+	OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
		+	ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
		+	CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
		+	SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
		+	NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
		+	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
		+	CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
		+	STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
		+	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
		+	ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		+
		+	</div>
		+
		+	== Thanks and Credits ==
		+	Thanks to all the kind people who contributed in one way or another. These are the credits:
		+
		+	* '''Dave Cameron''': for fixing bugs
		+	* '''Björn Carlson (hackerbaloo)''': for killing bugs that crept into the core
		+	* '''Emeric Fermas (nulltoken)''': for eliminating some of the hardest to find bugs and for verifying the complete test suite against jgit
		+	* '''Martinho Fernandes (eue)''': for fixing bugs
		+	* '''Andriano Machado (ammachado)''': for porting massive amounts of code and tests, also fixing many bugs
		+	* '''Jim Radford''': for the continuous integration server account and the support
		+	* '''Gil Ran''': for porting and fixing lots of tests and initial efforts on Mono
		+	* '''Meinrad Recheis (henon)''': I started this project and put all my effort into having it take off
		+	* '''Dan Rigby''': for setting up the #GitSharp irc channel as well as porting and fixing tests
		+	* '''rolenun''': for the command line interface framework. hey, what is your real name?
		+	* '''Stefan Schake (caytchen)''': for porting huge parts of the transport layer, and hunting down nasty bugs.
		+	* '''Mauricio Scheffer (mausch)''': for the testing and build server expertise and CI server trouble shooting
		+	* '''Neil Stalker (nestalk)''': for caring much about gitsharp's Mono compatibility and squashing bugs
		+	* '''Kevin Thompson''': for initially porting large amounts of code and letting me rise the baby
		+
		+	Furthermore, much appreciation and thanks to ...
		+
		+	* '''Linus Torvalds and the git community''' for creating and maintaining it.
		+	* '''Shawn O. Pearce and the jgit/egit community'''. Git# is based on their excellent work.
		+	--[[User:Henon|Henon]] 22:45, 13 October 2009 (CEST)
-	<div style="width:600px;"><pre>	+	== Links ==
-	todo	+	* [http://git.or.cz/ git]
-	</pre></div>	+	* [http://www.kernel.org/pub/software/scm/git/docs/ git online manual]
		+	* [http://www.eclipse.org/jgit JGit]
		+	* [http://www.git-scm.com git - classic package - source documentation and binaries]
		+	* [http://www.spheredev.org git 4 the lazy tutorial]

---

Latest revision as of 20:44, 26 May 2011

GitSharp - Git for .NET and Mono

... a native Windows version of the fast & free open source version control system

GitSharp is an implementation of Git for the Dot.Net Framework and Mono. It is aimed to be fully compatible to the original Git and shall be a light weight library for cool applications that are based on Git as their object database or are reading or manipulating repositories in some way.

Navigation: Downloads | Sources | API Docs | Bugs & Issues | Integration Server | Mailing List | GitSharp.Demo

Status of the Project

GitSharp is a quite usable and stable library used by several projects to interact with git repositories. To get an idea check out the Demo (see below)! GitSharp development is currently on hold because we believe that the libgit2 project and its C# bindings libgit2sharp are far more promising to work on.

Modules

• GitSharp.Core - a manual line by line port of jgit (outdated)
• GitSharp.CLI (git.exe) - quite incomplete
• GitSharp - a user friendly api designed to be easier to use and learn than GitSharp.Core

Projects using GitSharp

Bonobo Git Server

Jakub Chodounský created Bonobo Git Server for Windows (Git application server hosted on IIS with many features - based on the gitsharp library.

GitSharp.Demo

GitSharp.Demo is a small repository browser project that demonstrates the use of the GitSharp library and the user oriented API.

The source demonstrates how easy it is to ...

• open and interact with a git repository
• iterate over the file-tree of a specific revision
• get the contents of a single file of a specific revision
• get the changes between two commits
• display a modification as text diff

TicGit.net

TicGit.net a small distributed issue tracker that uses git to keep track of tickets. It demonstrates the use of gitsharp's commiting API. TicGit is a toy project inspired by Scott Chacon's ruby application "ticgit".

License

Git# is derived from the Java library jgit and is released under the same BSD license as jgit.

Please refer to the LICENSE.txt files for the complete license, and please refer to the individual source file header to determine which license covers it and who contributed and therefor holds copyrights to the files.

Thanks and Credits

Thanks to all the kind people who contributed in one way or another. These are the credits:

• Dave Cameron: for fixing bugs
• Björn Carlson (hackerbaloo): for killing bugs that crept into the core
• Emeric Fermas (nulltoken): for eliminating some of the hardest to find bugs and for verifying the complete test suite against jgit
• Martinho Fernandes (eue): for fixing bugs
• Andriano Machado (ammachado): for porting massive amounts of code and tests, also fixing many bugs
• Jim Radford: for the continuous integration server account and the support
• Gil Ran: for porting and fixing lots of tests and initial efforts on Mono
• Meinrad Recheis (henon): I started this project and put all my effort into having it take off
• Dan Rigby: for setting up the #GitSharp irc channel as well as porting and fixing tests
• rolenun: for the command line interface framework. hey, what is your real name?
• Stefan Schake (caytchen): for porting huge parts of the transport layer, and hunting down nasty bugs.
• Mauricio Scheffer (mausch): for the testing and build server expertise and CI server trouble shooting
• Neil Stalker (nestalk): for caring much about gitsharp's Mono compatibility and squashing bugs
• Kevin Thompson: for initially porting large amounts of code and letting me rise the baby

Furthermore, much appreciation and thanks to ...

• Linus Torvalds and the git community for creating and maintaining it.
• Shawn O. Pearce and the jgit/egit community. Git# is based on their excellent work.

--Henon 22:45, 13 October 2009 (CEST)

Links

• git
• git online manual
• JGit
• git - classic package - source documentation and binaries
• git 4 the lazy tutorial