summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Hoffmann <2836374+timhoffm@users.noreply.github.com>2019-08-05 12:20:59 +0200
committerIngy döt Net <ingy@ingy.net>2021-09-02 09:23:19 -0700
commit99d27e78e87838e96c4a859d3fb87e9d36407811 (patch)
tree3064a608d025cf6c4965d5f46f76ceba16d9da79
parentee37f4653c08fc07aecff69cfd92848e6b1a540e (diff)
downloadpyyaml-git-99d27e78e87838e96c4a859d3fb87e9d36407811.tar.gz
Change README format to Markdown
-rw-r--r--README43
-rw-r--r--README.md49
2 files changed, 49 insertions, 43 deletions
diff --git a/README b/README
deleted file mode 100644
index 49c87e7..0000000
--- a/README
+++ /dev/null
@@ -1,43 +0,0 @@
-PyYAML - The next generation YAML parser and emitter for Python.
-
-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)
-
-If you don't trust the input stream, you should use:
-
- >>> yaml.safe_load(stream)
-
-PyYAML includes a comprehensive test suite. To run the tests,
-type 'python setup.py test'.
-
-For more information, check the PyYAML homepage:
-'https://github.com/yaml/pyyaml'.
-
-For PyYAML tutorial and reference, see:
-'http://pyyaml.org/wiki/PyYAMLDocumentation'.
-
-Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net.
-
-You may also use 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'.
-
-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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd17932
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# 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)
+
+If you don't trust the input stream, you should use:
+
+ >>> yaml.safe_load(stream)
+
+## 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.