Commit Graph

15 Commits (b9e1fd18c1acbaa4b0028196f8925ce4e91970d9)

Author SHA1 Message Date
Remi Pointel cb5fe2c050 add OpenBSD installation instructions. 6 years ago
Adrien Vergé 930c8eea94 docs: Simplify installation instruction in the README 6 years ago
Adrien Vergé f66661e36d docs(cli): Add a paragraph about standard input
See commit 05dfcbc "cli: Add command line option - to read from standard
input", cc @miguelbarao.
6 years ago
Adrien Vergé a56a1015f0 style(docs): Fix RST lint errors reported by doc8 6 years ago
Adrien Vergé 66adaee66c docs: Add documentation on the new -f colored option 6 years ago
Adrien Vergé 203cfc20f0 docs: Remove sudo from pip installation instructions 7 years ago
Adrien Vergé 51c30505b5 docs: Add Mac OS installation instructions
See https://github.com/adrienverge/yamllint/issues/91 and
https://github.com/Homebrew/homebrew-core/blob/af2bbe9/Formula/yamllint.rb
7 years ago
Adrien Vergé ff9ebde608 docs: Remove old Debian / Ubuntu installation instructions 7 years ago
Adrien Vergé 2b7f5c5e72 docs(install): Update Debian version
yamllint is now backported in Debian 8 (Jessie):
https://tracker.debian.org/pkg/yamllint
https://packages.debian.org/source/jessie-backports/yamllint
8 years ago
Adrien Vergé a483524b63 Doc: Update installing section
Packages are now also available in Debian and Ubuntu.
9 years ago
Adrien Vergé 41733fc7a5 Use '.yaml' extension as default, not '.yml'
As someone said [1] on the internet:

    Say ".yaml" not ".yml".
    This is not MS-DOS, and YML is a Yahoo XML dialect.

Similarly, we use '.json', not '.jsn'.

[1]: https://github.com/ceph/s3-tests/commit/e17c56a
9 years ago
Adrien Vergé 688858e639 Doc: Reference Fedora and Ubuntu packages 9 years ago
Adrien Vergé 3f4f13e848 Doc: Update screenshot to include 'key-duplicates' 9 years ago
Adrien Vergé fee72d484e Doc: Add a screenshot 9 years ago
Adrien Vergé 38234a1d3c Doc: Generate documentation with Sphinx
HTML documentation should be built with sphinx. This enables easy
integration with Read The Docs [1]. It can also be generated manually by
running:

    make -C docs html

A man page can be generated by running:

    make -C docs man

[1]: http://yamllint.readthedocs.org/
9 years ago