debian-packages/dyaml
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #191 from BBasile/tuto-gh-pages

Browse source 
fix #190 - Possible broken link #190
merged-on-behalf-of: BBasile <BBasile@users.noreply.github.com>
This commit is contained in:
The Dlang Bot 2018-08-14 09:57:15 +02:00 committed by GitHub
parent 206995836d 2c9c40269e
commit 8c637e95ec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -5,19 +5,12 @@
## Introduction ## Introduction
D:YAML is an open source YAML parser and emitter library for the D D:YAML is an open source YAML parser and emitter library for the D programming language.
programming language. It is It is [almost](https://dlang-community.github.io/D-YAML/articles/spec_differences.html) compliant to the YAML 1.1 specification.
([almost](https://github.com/dlang-community/D-YAML/wiki/Differences-between-D:YAML-and-the-YAML-specification)) D:YAML is based on [PyYAML](http://www.pyyaml.org) created by Kirill Simonov.
compliant to the YAML 1.1 specification. D:YAML is based on
[PyYAML](http://www.pyyaml.org) created by Kirill Simonov.
D:YAML is designed to be easy to use while supporting the full feature D:YAML is designed to be easy to use while supporting the full feature set of YAML.
set of YAML. To start using it in your project, see the [Getting To start using it in your project, see the [Getting Started](https://dlang-community.github.io/D-YAML/tutorials/getting_started.html) tutorial.
Started](https://github.com/dlang-community/D-YAML/wiki/Getting-Started)
tutorial.
D:YAML is still a work in progress. Its API is not stable and there
might be compatibility breaking changes.
## Features ## Features
@ -49,19 +42,17 @@ might be compatibility breaking changes.
| Directory | Contents | | Directory | Contents |
|---------------|--------------------------------| |---------------|--------------------------------|
| `./` | This README, utility scripts. | | `./` | This README, utility scripts. |
| `./doc` | Documentation. | | `./docs` | Documentation. |
| `./docsrc` | Documentation sources. |
| `./source` | Source code. | | `./source` | Source code. |
| `./examples/` | Example projects using D:YAML. | | `./examples/` | Example projects using D:YAML. |
| `./test` | Unittest data. | | `./test` | Unittest data. |
## Installing and tutorial ## Installing and tutorial
See the [Getting See the [Getting Started](https://dlang-community.github.io/D-YAML/tutorials/getting_started.html).
Started](https://github.com/dlang-community/D-YAML/wiki/Getting-Started) Tutorial and other tutorials that can be found at the [GitHub pages](https://dlang-community.github.io/D-YAML/) or in the `docs` directory of the repository.
tutorial and other tutorials that can be found at the [GitHub
wiki](https://github.com/dlang-community/D-YAML/wiki) and in the API documentation is available [here](https://dyaml.dpldocs.info/dyaml.html).
`doc/html/tutorials/` directory in the package.
## License ## License
@ -101,12 +92,5 @@ also displayed here:
## Credits ## Credits
D:YAML was created by Ferdinand Majerech aka Kiith-Sa D:YAML was created by Ferdinand Majerech aka Kiith-Sa and is handled by the [dlang-community](https://github.com/dlang-community) organization since 2017.
kiithsacmp\[AT\]gmail.com . Parts of code based on [PyYAML](http://www.pyyaml.org) created by Kirill Simonov.
Parts of code based on [PyYAML](http://www.pyyaml.org) created by Kirill
Simonov.
D:YAML was created using Vim and DMD on Debian, Ubuntu and Linux Mint as
a YAML parsing library for the [D programming
language](http://www.dlang.org).

6
source/dyaml/constructor.d
View file

@ -5,9 +5,9 @@
// http://www.boost.org/LICENSE_1_0.txt) // http://www.boost.org/LICENSE_1_0.txt)
/** /**
* Class that processes YAML mappings, sequences and scalars into nodes. This can be * Class that processes YAML mappings, sequences and scalars into nodes.
* used to add custom data types. A tutorial can be found * This can be used to add custom data types. A tutorial can be found
* $(LINK2 ../tutorials/custom_types.html, here). * $(LINK2 https://dlang-community.github.io/D-YAML/, here).
*/ */
module dyaml.constructor; module dyaml.constructor;