Browse Source

docs(readme): add testing requirements section

tags/v0.2.2
Imran Iqbal 5 years ago
parent
commit
06de3188cf
No account linked to committer's email address
2 changed files with 18 additions and 0 deletions
  1. +3
    -0
      .gitignore
  2. +15
    -0
      docs/README.rst

+ 3
- 0
.gitignore View File



# copied `.md` files used for conversion to `.rst` using `m2r` # copied `.md` files used for conversion to `.rst` using `m2r`
docs/*.md docs/*.md

# Vim
*.sw?

+ 15
- 0
docs/README.rst View File



Linux testing is done with ``kitchen-salt``. Linux testing is done with ``kitchen-salt``.


Requirements
^^^^^^^^^^^^

* Ruby
* Docker

.. code-block:: bash

$ gem install bundler
$ bundle install
$ bundle exec kitchen test [platform]

Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
e.g. ``debian-9-2019-2-py3``.

``kitchen converge`` ``kitchen converge``
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^



Loading…
Cancel
Save