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

Updated README.

Browse source
This commit is contained in:
Ferdinand Majerech 2014-08-06 16:15:45 +02:00
parent 494dcd30d9
commit 3e69df499e
2 changed files with 13 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.html
View file

@ -349,9 +349,7 @@ ul.auto-toc {
language. It is language. It is
(<a class="reference external" href="https://github.com/kiith-sa/D-YAML/wiki/Differences-between-D:YAML-and-the-YAML-specification">almost</a>) (<a class="reference external" href="https://github.com/kiith-sa/D-YAML/wiki/Differences-between-D:YAML-and-the-YAML-specification">almost</a>)
compliant to the YAML 1.1 specification. D:YAML is based on compliant to the YAML 1.1 specification. D:YAML is based on
<a class="reference external" href="http://www.pyyaml.org">PyYAML</a> created by Kirill Simonov. It has no external <a class="reference external" href="http://www.pyyaml.org">PyYAML</a> created by Kirill Simonov.</p>
dependencies, it only needs a D compiler and Phobos (standard library). It is
written in D2 and there are no plans for D1 support.</p>
<p>D:YAML is designed to be easy to use while supporting the full feature set of <p>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
<a class="reference external" href="https://github.com/kiith-sa/D-YAML/wiki/Getting-Started">Getting Started</a> <a class="reference external" href="https://github.com/kiith-sa/D-YAML/wiki/Getting-Started">Getting Started</a>
@ -365,7 +363,6 @@ compatibility breaking changes.</p>
<li>Easy to use, high level API and detailed debugging messages.</li> <li>Easy to use, high level API and detailed debugging messages.</li>
<li>Detailed API documentation and tutorials.</li> <li>Detailed API documentation and tutorials.</li>
<li>Code examples.</li> <li>Code examples.</li>
<li>No external dependencies.</li>
<li>Supports all YAML 1.1 constructs. All examples from the YAML 1.1 specification <li>Supports all YAML 1.1 constructs. All examples from the YAML 1.1 specification
are parsed correctly.</li> are parsed correctly.</li>
<li>Reads from and writes from/to YAML files or in-memory buffers.</li> <li>Reads from and writes from/to YAML files or in-memory buffers.</li>
@ -400,7 +397,7 @@ There are no plans to implement this at the moment.</li>
</thead> </thead>
<tbody valign="top"> <tbody valign="top">
<tr><td><tt class="docutils literal">./</tt></td> <tr><td><tt class="docutils literal">./</tt></td>
<td>This README file, utility scripts, D:YAML sources outside any packages.</td> <td>This README, utility scripts.</td>
</tr> </tr>
<tr><td><tt class="docutils literal">./doc</tt></td> <tr><td><tt class="docutils literal">./doc</tt></td>
<td>Documentation.</td> <td>Documentation.</td>
@ -408,14 +405,14 @@ There are no plans to implement this at the moment.</li>
<tr><td><tt class="docutils literal">./docsrc</tt></td> <tr><td><tt class="docutils literal">./docsrc</tt></td>
<td>Documentation sources.</td> <td>Documentation sources.</td>
</tr> </tr>
<tr><td><tt class="docutils literal">./dyaml</tt></td> <tr><td><tt class="docutils literal">./source</tt></td>
<td>D:YAML source code.</td> <td>Source code.</td>
</tr> </tr>
<tr><td><tt class="docutils literal">./examples/</tt></td> <tr><td><tt class="docutils literal">./examples/</tt></td>
<td>Example D:YAML code.</td> <td>Example projects using D:YAML.</td>
</tr> </tr>
<tr><td><tt class="docutils literal">./test</tt></td> <tr><td><tt class="docutils literal">./test</tt></td>
<td>Unittest code and data.</td> <td>Unittest data.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -468,9 +465,7 @@ DEALINGS IN THE SOFTWARE.
<h1>Credits</h1> <h1>Credits</h1>
<p>D:YAML was created by Ferdinand Majerech aka Kiith-Sa kiithsacmp[AT]gmail.com .</p> <p>D:YAML was created by Ferdinand Majerech aka Kiith-Sa kiithsacmp[AT]gmail.com .</p>
<p>Parts of code based on <a class="reference external" href="http://www.pyyaml.org">PyYAML</a> created by Kirill Simonov.</p> <p>Parts of code based on <a class="reference external" href="http://www.pyyaml.org">PyYAML</a> created by Kirill Simonov.</p>
<p>D:YAML uses a modified version of the <p>D:YAML was created using Vim and DMD on Debian, Ubuntu and Linux Mint as a YAML parsing
<a class="reference external" href="http://www.dsource.org/projects/cdc">CDC build script</a>.</p>
<p>D:YAML was created using Vim and DMD on Debian and Ubuntu Linux as a YAML parsing
library for the <a class="reference external" href="http://www.dlang.org">D programming language</a>.</p> library for the <a class="reference external" href="http://www.dlang.org">D programming language</a>.</p>
</div> </div>
</div> </div>

18
README.rst
View file

@ -13,9 +13,7 @@ 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/kiith-sa/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. It has no external `PyYAML <http://www.pyyaml.org>`_ created by Kirill Simonov.
dependencies, it only needs a D compiler and Phobos (standard library). It is
written in D2 and there are no plans for D1 support.
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
@ -33,7 +31,6 @@ Features
* Easy to use, high level API and detailed debugging messages. * Easy to use, high level API and detailed debugging messages.
* Detailed API documentation and tutorials. * Detailed API documentation and tutorials.
* Code examples. * Code examples.
* No external dependencies.
* Supports all YAML 1.1 constructs. All examples from the YAML 1.1 specification * Supports all YAML 1.1 constructs. All examples from the YAML 1.1 specification
are parsed correctly. are parsed correctly.
* Reads from and writes from/to YAML files or in-memory buffers. * Reads from and writes from/to YAML files or in-memory buffers.
@ -61,12 +58,12 @@ Directory structure
=============== ======================================================================= =============== =======================================================================
Directory Contents Directory Contents
=============== ======================================================================= =============== =======================================================================
``./`` This README file, utility scripts, D:YAML sources outside any packages. ``./`` This README, utility scripts.
``./doc`` Documentation. ``./doc`` Documentation.
``./docsrc`` Documentation sources. ``./docsrc`` Documentation sources.
``./dyaml`` D:YAML source code. ``./source`` Source code.
``./examples/`` Example D:YAML code. ``./examples/`` Example projects using D:YAML.
``./test`` Unittest code and data. ``./test`` Unittest data.
=============== ======================================================================= =============== =======================================================================
@ -128,8 +125,5 @@ 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. Parts of code based on `PyYAML <http://www.pyyaml.org>`_ created by Kirill Simonov.
D:YAML uses a modified version of the D:YAML was created using Vim and DMD on Debian, Ubuntu and Linux Mint as a YAML parsing
`CDC build script <http://www.dsource.org/projects/cdc>`_.
D:YAML was created using Vim and DMD on Debian and Ubuntu Linux as a YAML parsing
library for the `D programming language <http://www.dlang.org>`_. library for the `D programming language <http://www.dlang.org>`_.