Skip to content

Commit

Permalink
Change README format to Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
timhoffm committed Aug 5, 2019
1 parent 0f64cbf commit 7372137
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 39 deletions.
39 changes: 0 additions & 39 deletions README

This file was deleted.

45 changes: 45 additions & 0 deletions README.md
@@ -0,0 +1,45 @@
# PyYAML - The next generation YAML parser and emitter for Python.

## Installing

To install, type `python setup.py install`.

By default, the `setup.py` script checks whether LibYAML is installed
and if so, builds and installs LibYAML bindings. To skip the check
and force installation of LibYAML bindings, use the option `--with-libyaml`:
`python setup.py --with-libyaml install`. To disable the check and
skip building and installing LibYAML bindings, use `--without-libyaml`:
`python setup.py --without-libyaml install`.

When LibYAML bindings are installed, you may use fast LibYAML-based
parser and emitter as follows:

>>> yaml.load(stream, Loader=yaml.CLoader)
>>> yaml.dump(data, Dumper=yaml.CDumper)

## Testing

PyYAML includes a comprehensive test suite. To run the tests,
type `python setup.py test`.

## Further Information

- For more information, check the
[PyYAML homepage](https://github.com/yaml/pyyaml).

- [PyYAML tutorial and reference](http://pyyaml.org/wiki/PyYAMLDocumentation).

- Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net or on
the [YAML-Core mailing list](
http://lists.sourceforge.net/lists/listinfo/yaml-core).

- Submit bug reports and feature requests to the
[PyYAML bug tracker](https://github.com/yaml/pyyaml/issues).

## License

The PyYAML module was written by Kirill Simonov <xi@resolvent.net>.
It is currently maintained by the YAML and Python communities.

PyYAML is released under the MIT license.
See the file LICENSE for more details.

0 comments on commit 7372137

Please sign in to comment.