README.md

   1 TortoiseGit - The coolest Interface to Git Version Control\r
   2 ==========================================================\r
   3 \r
   4 TortoiseGit is a Windows Shell Interface to Git based on TortoiseSVN. It's open source and can be built entirely with freely available software.\r
   5 \r
   6 TortoiseGit supports you with regular tasks, such as committing, showing logs, diffing two versions, creating branches and tags, creating patches and so on (see our [Screenshots](https://tortoisegit.org/about/screenshots/) or [documentation](https://tortoisegit.org/docs/)).\r
   7 \r
   8 * Website: [tortoisegit.org](https://tortoisegit.org)\r
   9 * Download: [tortoisegit.org/download](https://tortoisegit.org/download)\r
  10 * Documentation: [tortoisegit.org/docs/](https://tortoisegit.org/docs/)\r
  11 * Support: [tortoisegit.org/support/](https://tortoisegit.org/support/)\r
  12 * Issue tracker: [tortoisegit.org/issues](https://tortoisegit.org/issues)\r
  13 * Contribute: [tortoisegit.org/contribute/](https://tortoisegit.org/contribute/)\r
  14 * Mailing lists: [tortoisegit-announce](https://groups.google.com/group/tortoisegit-announce),\r
  15                  [tortoisegit-users](https://groups.google.com/group/tortoisegit-users) and\r
  16                  [tortoisegit-dev](https://groups.google.com/group/tortoisegit-dev)\r
  17 * StackOverflow tag: [tortoisegit](https://stackoverflow.com/questions/tagged/tortoisegit)\r
  18 \r
  19 Download\r
  20 --------\r
  21 \r
  22 The latest release and language packs are available on the [download page](https://tortoisegit.org/download). There you can also find the system requirements and latest release notes.\r
  23 \r
  24 The TortoiseGit team also provides [preview releases](https://download.tortoisegit.org/tgit/previews/) on an irregular basis. These versions are used by the TortoiseGit developers and are built from the latest code that represents the cutting edge of the TortoiseGit development.\r
  25 \r
  26 What to do if things go wrong or a crash happened\r
  27 --------------------------------------------------\r
  28 \r
  29 Before reporting an issue, please search whether a similar issue already exists and check that your problem isn't fixed in our latest [preview release](https://download.tortoisegit.org/tgit/previews/).\r
  30 \r
  31 An important aspect of reporting issues is to have a reproducible example of the issue; it's also important to mention the exact version of your operating system, the version of Git and the version of TortoiseGit (this information can be found on the TortoiseGit about dialog).\r
  32 \r
  33 TortoiseGit includes a crash reporter (if not disabled on installation), which automatically uploads crash dumps to drdump.com, where the TortoiseGit team can review them. If you have a reproducible example, please also file an issue and link the crash report.\r
  34 \r
  35 We have a special page describing [steps for debugging](src/Debug-Hints.txt), where the majority of these steps do not require you to build TortoiseGit on your own.\r
  36 \r
  37 How Can I Contribute?\r
  38 =====================\r
  39 \r
  40 You're welcome to contribute to this project! There are several aspects you can help on:\r
  41 \r
  42 * improving our [documentation](https://tortoisegit.org/docs/) (see [doc/readme.txt](doc/readme.txt) file and [doc](doc) folder),\r
  43 * [translations](Languages/README.txt),\r
  44 * testing [preview releases](https://download.tortoisegit.org/tgit/previews/),\r
  45 * helping other users on the mailing lists,\r
  46 * improving our UIs, or also\r
  47 * coding (e.g., fix open issues or implement new features; see below for more information).\r
  48 \r
  49 Any help is appreciated!\r
  50 \r
  51 Feel free to report issues and open merge requests.\r
  52 \r
  53 Please also check the [contribution guidelines](doc/HowToContribute.txt) to understand our\r
  54 workflow.\r
  55 \r
  56 How to build\r
  57 ------------\r
  58 \r
  59 Building TortoiseGit normally is not necessary; however, it is easy. All necessary requirements and steps are described in the [build.txt](build.txt) file. Our short description in the [architecture.txt](architecture.txt) file might also be helpful.\r
  60 \r
  61 License\r
  62 =======\r
  63 \r
  64 TortoiseGit is licensed under the [GPLv2](src/gpl.txt).\r
  65 \r