Skip to content

Commit 8774c47

Browse files
author
Edward Thomson
authored
Merge pull request libgit2#3831 from libgit2/ethomson/readme
Improve the README
2 parents 37e9278 + 2976dcf commit 8774c47

File tree

1 file changed

+35
-18
lines changed

1 file changed

+35
-18
lines changed

README.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,30 @@ with any kind of software without having to release its source code.
1515
Additionally, the example code has been released to the public domain (see the
1616
[separate license](examples/COPYING) for more information).
1717

18-
* Website: [libgit2.github.com](http://libgit2.github.com)
19-
* StackOverflow Tag: [libgit2](http://stackoverflow.com/questions/tagged/libgit2)
20-
* Issues: [GitHub Issues](https://github.com/libgit2/libgit2/issues) (Right here!)
21-
* API documentation: <http://libgit2.github.com/libgit2/>
22-
* IRC: [#libgit2](irc://irc.freenode.net/libgit2) on irc.freenode.net.
23-
* Mailing list: The libgit2 mailing list was
24-
traditionally hosted in Librelist but has been deprecated. We encourage you to
25-
[use StackOverflow](http://stackoverflow.com/questions/tagged/libgit2) instead for any questions regarding
26-
the library, or [open an issue](https://github.com/libgit2/libgit2/issues)
27-
on GitHub for bug reports. The mailing list archives are still available at
28-
<http://librelist.com/browser/libgit2/>.
18+
Getting Help
19+
============
2920

21+
**Join us on Slack**
22+
23+
Visit [slack.libgit2.org](http://slack.libgit2.org/) to sign up, then join
24+
us in `#libgit2`. If you prefer IRC, you can also point your client to our
25+
slack channel once you've registered.
26+
27+
**Getting Help**
28+
29+
If you have questions about the library, please be sure to check out the
30+
[API documentation](http://libgit2.github.com/libgit2/). If you still have
31+
questions, reach out to us on Slack or post a question on
32+
[StackOverflow](http://stackoverflow.com/questions/tagged/libgit2) (with the `libgit2` tag).
33+
34+
**Reporting Bugs**
35+
36+
Please open a [GitHub Issue](https://github.com/libgit2/libgit2/issues) and
37+
include as much information as possible. If possible, provide sample code
38+
that illustrates the problem you're seeing. If you're seeing a bug only
39+
on a specific repository, please provide a link to it if possible.
40+
41+
We ask that you not open a GitHub Issue for help, only for bug reports.
3042

3143
What It Can Do
3244
==============
@@ -202,7 +214,6 @@ Here are the bindings to libgit2 that are currently available:
202214
* .NET
203215
* libgit2sharp <https://github.com/libgit2/libgit2sharp>
204216
* Node.js
205-
* node-gitteh <https://github.com/libgit2/node-gitteh>
206217
* nodegit <https://github.com/nodegit/nodegit>
207218
* Objective-C
208219
* objective-git <https://github.com/libgit2/objective-git>
@@ -215,7 +226,7 @@ Here are the bindings to libgit2 that are currently available:
215226
* PHP
216227
* php-git <https://github.com/libgit2/php-git>
217228
* PowerShell
218-
* GitPowerShell <https://github.com/ethomson/gitpowershell>
229+
* PSGit <https://github.com/PoshCode/PSGit>
219230
* Python
220231
* pygit2 <https://github.com/libgit2/pygit2>
221232
* R
@@ -235,16 +246,22 @@ we can add it to the list.
235246
How Can I Contribute?
236247
==================================
237248

238-
Check the [contribution guidelines](CONTRIBUTING.md) to understand our
239-
workflow, the libgit2 [coding conventions](CONVENTIONS.md), and our list of
240-
[good starting projects](PROJECTS.md).
249+
We welcome new contributors! We have a number of issues marked as
250+
["up for grabs"](https://github.com/libgit2/libgit2/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22)
251+
and
252+
["easy fix"](https://github.com/libgit2/libgit2/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3A%22easy+fix%22)
253+
that are good places to jump in and get started. There's much more detailed
254+
information in our list of [outstanding projects](PROJECTS.md).
255+
256+
Please be sure to check the [contribution guidelines](CONTRIBUTING.md) to
257+
understand our workflow, and the libgit2 [coding conventions](CONVENTIONS.md).
241258

242259
License
243260
==================================
244261

245262
`libgit2` is under GPL2 **with linking exception**. This means you can link to
246263
and use the library from any program, proprietary or open source; paid or
247-
gratis. However, you cannot modify libgit2 and distribute it without
248-
supplying the source.
264+
gratis. However, if you modify libgit2 itself, you must distribute the
265+
source to your modified version of libgit2.
249266

250267
See the [COPYING file](COPYING) for the full license text.

0 commit comments

Comments
 (0)