dmd/README.md
MoonlightSentinel 747a68bfdd
Revise introduction and add an overview of the repository structure
Ease the navigation for new users by pointing them to the correct
documents that supply the information they need.
2022-01-13 19:01:40 +01:00

45 lines
2.8 KiB
Markdown

<div align="center">
![dlang logo](https://dlang.org/images/dlogo.png)
# DMD
[![GitHub tag](https://img.shields.io/github/tag-date/dlang/dmd.svg?maxAge=86400&style=flat)](https://github.com/dlang/dmd/releases)
[![Code coverage](https://img.shields.io/codecov/c/github/dlang/dmd.svg?maxAge=86400&style=flat)](https://codecov.io/gh/dlang/dmd)
[![Bugzilla Issues](https://img.shields.io/badge/issues-Bugzilla-green.svg?style=flat)](https://issues.dlang.org/buglist.cgi?component=dmd&list_id=220151&product=D&resolution=---)
[![license](https://img.shields.io/github/license/dlang/dmd.svg?style=flat)](https://github.com/dlang/dmd/blob/master/LICENSE.txt)
[![Build status](https://img.shields.io/cirrus/github/dlang/dmd/master?label=Cirrus%20CI&logo=Cirrus%20CI)](https://cirrus-ci.com/github/dlang/dmd/master)
[![CircleCI](https://img.shields.io/circleci/project/github/dlang/dmd/master.svg?style=flat&label=circleci&logo=circleci)](https://circleci.com/gh/dlang/dmd/tree/master)
[![Build Status](https://dev.azure.com/dlanguage/dmd/_apis/build/status/Azure%20pipelines?branchName=master)](https://dev.azure.com/dlanguage/dmd/_build/latest?definitionId=1&branchName=master)
[![Buildkite](https://img.shields.io/buildkite/01239dde8424d69809d08769015bbdb9b90d05082e534d2f82/master.svg?style=flat&logo=dependabot&label=buildkite)](https://buildkite.com/dlang/dmd)
</div>
---
**DMD** is the reference compiler for the D programming language.
Releases, language specification and other resources can be found on the [homepage](https://dlang.org).
Please refer to the guidelines for [bug reports](CONTRIBUTING.md#reporting-bugs) to
report a problem or browse the list of open bugs.
### Overview
This repository is structured into the following directories.
Refer to their respective `README.md` for more in-depth information.
| Directory | Description |
|------------------------|--------------------------------------------------|
| [src](src) | source code, build system and build instructions |
| [test](test) | tests and testing infrastructure |
| [changelog](changelog) | changelog entries for the upcoming release |
| [ci](ci) | CI related scripts / utilities |
| [docs](docs) | man pages and internal documentation |
| [ini](ini) | predefined `dmd.conf` files |
| [samples](samples) | Various code examples |
For more general information regarding compiling, installing, and
hacking on DMD, check the [contribution guide](CONTRIBUTING.md) and
visit the [D Wiki](https://wiki.dlang.org/DMD).
### Nightlies
Nightly builds based of the current DMD / DRuntime / Phobos `master` branch
can be found [here](https://github.com/dlang/dmd/releases/tag/nightly).