From 2c9c40269ec1fba92312e94bda987aa2ee3f74fc Mon Sep 17 00:00:00 2001 From: Basile Burg Date: Tue, 14 Aug 2018 09:35:22 +0200 Subject: [PATCH] fix #190 - Possible broken link #190 --- README.md | 40 ++++++++++++-------------------------- source/dyaml/constructor.d | 6 +++--- 2 files changed, 15 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 3ee4d6a..a75bdab 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,12 @@ ## Introduction -D:YAML is an open source YAML parser and emitter library for the D -programming language. It is -([almost](https://github.com/dlang-community/D-YAML/wiki/Differences-between-D:YAML-and-the-YAML-specification)) -compliant to the YAML 1.1 specification. D:YAML is based on -[PyYAML](http://www.pyyaml.org) created by Kirill Simonov. +D:YAML is an open source YAML parser and emitter library for the D programming language. +It is [almost](https://dlang-community.github.io/D-YAML/articles/spec_differences.html) 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 -set of YAML. To start using it in your project, see the [Getting -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. +D:YAML is designed to be easy to use while supporting the full feature set of YAML. +To start using it in your project, see the [Getting Started](https://dlang-community.github.io/D-YAML/tutorials/getting_started.html) tutorial. ## Features @@ -49,19 +42,17 @@ might be compatibility breaking changes. | Directory | Contents | |---------------|--------------------------------| | `./` | This README, utility scripts. | -| `./doc` | Documentation. | -| `./docsrc` | Documentation sources. | +| `./docs` | Documentation. | | `./source` | Source code. | | `./examples/` | Example projects using D:YAML. | | `./test` | Unittest data. | ## Installing and tutorial -See the [Getting -Started](https://github.com/dlang-community/D-YAML/wiki/Getting-Started) -tutorial and other tutorials that can be found at the [GitHub -wiki](https://github.com/dlang-community/D-YAML/wiki) and in the -`doc/html/tutorials/` directory in the package. +See the [Getting Started](https://dlang-community.github.io/D-YAML/tutorials/getting_started.html). +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. + +API documentation is available [here](https://dyaml.dpldocs.info/dyaml.html). ## License @@ -101,12 +92,5 @@ also displayed here: ## Credits -D:YAML was created by Ferdinand Majerech aka Kiith-Sa -kiithsacmp\[AT\]gmail.com . - -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). +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. +Parts of code based on [PyYAML](http://www.pyyaml.org) created by Kirill Simonov. diff --git a/source/dyaml/constructor.d b/source/dyaml/constructor.d index bd56530..4b76856 100644 --- a/source/dyaml/constructor.d +++ b/source/dyaml/constructor.d @@ -5,9 +5,9 @@ // http://www.boost.org/LICENSE_1_0.txt) /** - * Class that processes YAML mappings, sequences and scalars into nodes. This can be - * used to add custom data types. A tutorial can be found - * $(LINK2 ../tutorials/custom_types.html, here). + * Class that processes YAML mappings, sequences and scalars into nodes. + * This can be used to add custom data types. A tutorial can be found + * $(LINK2 https://dlang-community.github.io/D-YAML/, here). */ module dyaml.constructor;