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

Update readme (#55)

Browse source 
* Update README.rst and dub.json
* Remove dead documentation links in the readme file
This commit is contained in:
Petar Kirov 2017-05-16 23:02:26 +03:00 committed by GitHub
parent 8e1e9893d1
commit 6d518c27ee
2 changed files with 12 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.rst
View file

@ -2,16 +2,13 @@
D:YAML 0.5 D:YAML 0.5
========== ==========
This is a fork of the D:YAML library by kiith-sa (https://github.com/kiith-sa/D-YAML). .. image:: https://travis-ci.org/dlang-community/D-YAML.svg?branch=master
The intent of this fork is to provide a version suitable for use by dlang-tour, until :target: https://travis-ci.org/dlang-community/D-YAML
fixes are accepted upstream. .. image:: https://img.shields.io/dub/v/dyaml.svg
:target: http://code.dlang.org/packages/dyaml
.. image:: https://travis-ci.org/dlang-tour/dyaml-dlang-tour.svg?branch=master
.. image:: https://img.shields.io/dub/v/dyaml-dlang-tour.svg
:target: http://code.dlang.org/packages/dyaml-dlang-tour
**Note**: D:YAML 0.5 brings some **breaking changes**. See the **Note**: D:YAML 0.5 brings some **breaking changes**. See the
`changelog <https://github.com/kiith-sa/D-YAML/blob/master/CHANGES.rst>`_. `changelog <https://github.com/dlang-community/D-YAML/blob/master/CHANGES.rst>`_.
------------ ------------
Introduction Introduction
@ -19,14 +16,14 @@ Introduction
D:YAML is an open source YAML parser and emitter library for the D programming D:YAML is an open source YAML parser and emitter library for the D programming
language. It is language. It is
(`almost <https://github.com/kiith-sa/D-YAML/wiki/Differences-between-D:YAML-and-the-YAML-specification>`_) (`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 compliant to the YAML 1.1 specification. D:YAML is based on
`PyYAML <http://www.pyyaml.org>`_ created by Kirill Simonov. `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 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 YAML. To start using it in your project, see the
`Getting Started <https://github.com/kiith-sa/D-YAML/wiki/Getting-Started>`_ `Getting Started <https://github.com/dlang-community/D-YAML/wiki/Getting-Started>`_
tutorial and the `documentation <http://defenestrate.eu/docs/dyaml/>`_. tutorial.
D:YAML is still a work in progress. Its API is not stable and there might be D:YAML is still a work in progress. Its API is not stable and there might be
compatibility breaking changes. compatibility breaking changes.
@ -80,11 +77,10 @@ Installing and tutorial
----------------------- -----------------------
See the See the
`Getting Started <https://github.com/kiith-sa/D-YAML/wiki/Getting-Started>`_ `Getting Started <https://github.com/dlang-community/D-YAML/wiki/Getting-Started>`_
tutorial and other tutorials that can be found at the tutorial and other tutorials that can be found at the
`GitHub wiki <https://github.com/kiith-sa/D-YAML/wiki>`_ `GitHub wiki <https://github.com/dlang-community/D-YAML/wiki>`_
and in the ``doc/html/tutorials/`` directory in the package. and in the ``doc/html/tutorials/`` directory in the package.
For advanced usage, see the `documentation <http://defenestrate.eu/docs/dyaml/>`_.
------- -------

4
dub.json
View file

@ -1,12 +1,12 @@
{ {
"name": "dyaml-dlang-tour", "name": "dyaml",
"description": "YAML parser and emitter", "description": "YAML parser and emitter",
"authors": [ "Ferdinand Majerech" ], "authors": [ "Ferdinand Majerech" ],
"libs": [], "libs": [],
"importPaths": ["source"], "importPaths": ["source"],
"license": "Boost 1.0", "license": "Boost 1.0",
"dependencies": { "tinyendian" : { "version" : "~>0.1.0" } }, "dependencies": { "tinyendian" : { "version" : "~>0.1.0" } },
"homepage": "https://github.com/kiith-sa/D-YAML", "homepage": "https://github.com/dlang-community/D-YAML",
"copyright": "Copyright © 2011-2014, Ferdinand Majerech", "copyright": "Copyright © 2011-2014, Ferdinand Majerech",
"buildTypes": "buildTypes":