Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1454 from qznc/readme
Add README and CONTRIBUTING files
- Loading branch information
Showing
2 changed files
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
Guidelines for Contributing | ||
=========================== | ||
|
||
Welcome to the D community and thanks for your interest in contributing! | ||
|
||
# [How to contribute pull requests?](http://wiki.dlang.org/Pull_Requests) | ||
|
||
# More Links | ||
|
||
* Fork [on Github](https://github.com/D-Programming-Language/phobos) | ||
* Use our [Bugzilla bug tracker](http://d.puremagic.com/issues/) | ||
* Follow the [Styleguide](http://dlang.org/dstyle.html) | ||
* Participate in [our forum](http://forum.dlang.org/) | ||
* [Review Queue](http://wiki.dlang.org/Review_Queue). | ||
|
||
|
||
Tips for Development | ||
-------------------- | ||
|
||
1. Build and test (e.g. the regex module) | ||
|
||
rdmd -unittest -main std/regex.d | ||
|
||
2. Do not forget to test your changes. | ||
Aim for a [high code coverage of your tests](http://forum.dlang.org/thread/ki5ovr$17m1$1@digitalmars.com). | ||
|
||
3. Do not forget the [API Documentation](http://dlang.org/phobos/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
![D Logo](http://dlang.org/images/dlogo.png) Phobos Runtime Library | ||
=================================================================== | ||
|
||
Phobos is the standard runtime library that comes with the | ||
[D Programming Language](http://dlang.org) Compiler. | ||
|
||
|
||
* [Bugzilla bug tracker](http://d.puremagic.com/issues/) | ||
* [Forum](http://forum.dlang.org/) | ||
* [API Documentation](http://dlang.org/phobos/) | ||
* [Wiki](http://wiki.dlang.org/) | ||
|
||
Download | ||
-------- | ||
|
||
Phobos packaged together with the compiler. | ||
You should | ||
[download the whole precompiled package](http://dlang.org/download.html). | ||
|
||
To [build everything yourself](http://wiki.dlang.org/Building_DMD), | ||
there is a [description in the wiki](http://wiki.dlang.org/Building_DMD). | ||
|
||
Phobos is distributed under Boost Software Licence. | ||
See the [licence file](LICENSE_1_0.txt). | ||
|
||
I Want to Contribute | ||
-------------------- | ||
|
||
Great! | ||
See the [CONTRIBUTING.md file](CONTRIBUTING.md). | ||
|