Add README.md
[TortoiseGit.git] / README.md
blob68c4774052bf5674c21f27fa18495b4f0c728cc6
1 TortoiseGit - The coolest Interface to Git Version Control\r
2 ==========================================================\r
3 \r
4 TortoiseGit is a Windows Shell Interface to Git and based on TortoiseSVN. It's open source and can fully be build with freely available software.\r
5 \r
6 TortoiseGit supports you by regular tasks, such as committing, showing logs, diffing two versions, creating branches and tags, creating patches and so on (see our [Screenshots](https://code.google.com/p/tortoisegit/wiki/Screenshots) or [documentation](https://tortoisegit.org/docs/tortoisegit/)).\r
7 \r
8 * Website: [tortoisegit.org](https://tortoisegit.org)\r
9 * Issues: [issue tracker](https://tortoisegit.org/issues)\r
10 * Mailing lists: [tortoisegit-announce](https://groups.google.com/group/tortoisegit-announce),\r
11                  [tortoisegit-users](https://groups.google.com/group/tortoisegit-users) and\r
12                  [tortoisegit-dev](https://groups.google.com/group/tortoisegit-dev)\r
13 * StackOverflow tag: [tortoisegit](http://stackoverflow.com/questions/tagged/tortoisegit)\r
15 Download\r
16 --------\r
18 The latest release and language packs are available on the [download page](https://tortoisegit.org/download).\r
20 How to build\r
21 ------------\r
23 Building TortoiseGit is easy. All necessary requirements and steps are described in the [build.txt](build.txt) file. Helpful might also be our a short description of the [architecture](https://code.google.com/p/tortoisegit/wiki/TortoiseGit_Overall_Architecture).\r
25 How Can I Contribute?\r
26 =====================\r
28 You're welcome to contribute to this project (help on coding, documentation, [Translation](https://tortoisegit.org/translate), testing [preview releases]([https://download.tortoisegit.org/tgit/previews/) or helping other users on the mailing lists is really appreciated). \r
30 Feel free to report issues and pull requests.\r
32 Please also check the [contribution guidelines](doc/HowToContribute.txt) to understand our\r
33 workflow.\r
35 License\r
36 =======\r
38 TortoiseGit is licensed under GPL2.\r
40 See the [COPYING file](src/gpl.txt) for the full license text.\r