diff options
Diffstat (limited to 'docs/markdown/Dlang-module.md')
| -rw-r--r-- | docs/markdown/Dlang-module.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/markdown/Dlang-module.md b/docs/markdown/Dlang-module.md index d344143..ca9a381 100644 --- a/docs/markdown/Dlang-module.md +++ b/docs/markdown/Dlang-module.md @@ -7,11 +7,14 @@ This module provides tools related to the D programming language. To use this module, just do: **`dlang = import('dlang')`**. You can, of course, replace the name `dlang` with anything else. -The module only exposes one funtion, `generate_dub_file`, used to automatically generate Dub configuration files. +The module only exposes one fucntion, `generate_dub_file`, used to +automatically generate Dub configuration files. ### generate_dub_file() -This method only has two required arguments, the project name and the source folder. -You can pass other arguments with additional keywords, they will be automatically translated to json and added to the `dub.json` file. +This method only has two required arguments, the project name and the +source folder. You can pass other arguments with additional keywords, +they will be automatically translated to json and added to the +`dub.json` file. **Structure** ```meson @@ -32,10 +35,9 @@ dlang.generate_dub_file(meson.project_name().to_lower(), meson.source_root(), ) ``` -You can manually edit a meson generated `dub.json` file or provide a initial one. -The module will only update the values specified in `generate_dub_file()`. +You can manually edit a meson generated `dub.json` file or provide a +initial one. The module will only update the values specified in +`generate_dub_file()`. -Although not required, you will need to have a `description` and `license` if you want to publish the package in the [D package registry](https://code.dlang.org/). - -Other thing to keep in mind is that currently, the module ignores `configurations`, `subConfigurations`, and `buildTypes`. -You can configure that directly in `dub.json`. +Although not required, you will need to have a `description` and +`license` if you want to publish the package in the [D package registry](https://code.dlang.org/).
\ No newline at end of file |