Skip to content

Commit 1740893

Browse files
authored
Merge pull request #111 from ronja-koistinen/main
Fixes to README
2 parents 6d7f3e1 + ae85cf1 commit 1740893

1 file changed

Lines changed: 18 additions & 7 deletions

File tree

README

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ IIIF Validator
44

55
.. image:: https://github.com/github/docs/actions/workflows/test.yml/badge.svg
66
:target: https://github.com/IIIF/image-validator/actions
7-
7+
88
.. image:: https://coveralls.io/repos/github/IIIF/image-validator/badge.svg?branch=main
99
:target: https://coveralls.io/github/IIIF/image-validator?branch=main
1010

@@ -99,7 +99,12 @@ As an example, if the test server <https://pypi.python.org/pypi/iiif> is install
9999
easy_install iiif
100100
iiif_testserver.py
101101

102-
which will set up a server at `<http://localhost:8000/>`_ and write the log of accesses to STDOUT. The one can run validation tests against this with requests like `<http://localhost:8080/info_json?server=localhost:8000&prefix=/2.0_pil_none&identifier=67352ccc-d1b0-11e1-89ae-279075081939.png&version=2.0>`_ which tests the `info.json` response and gives JSON output (pretty formatted here)::
102+
which will set up a server at `<http://localhost:8000/>`_ and write the log of accesses to STDOUT.
103+
The one can run validation tests against this with requests like
104+
`<http://localhost:8080/info_json?server=localhost:8000&prefix=/2.0_pil_none&identifier=67352ccc-d1b0-11e1-89ae-279075081939.png&version=2.0>`_
105+
which tests the `info.json` response and gives JSON output (pretty formatted here):
106+
107+
.. code-block:: json
103108

104109
{
105110
"test": "info_json",
@@ -109,7 +114,10 @@ which will set up a server at `<http://localhost:8000/>`_ and write the log of a
109114
"label": "Check Image Information"
110115
}
111116

112-
and `<http://localhost:8080/rot_mirror?server=localhost:8000&prefix=/2.0_pil_none&identifier=67352ccc-d1b0-11e1-89ae-279075081939.png&version=2.0>`_ which tests mirroring and will give JSON output (again pretty formatted)::
117+
and `<http://localhost:8080/rot_mirror?server=localhost:8000&prefix=/2.0_pil_none&identifier=67352ccc-d1b0-11e1-89ae-279075081939.png&version=2.0>`_
118+
which tests mirroring and will give JSON output (again pretty formatted):
119+
120+
.. code-block:: json
113121

114122
{
115123
"test": "rot_mirror",
@@ -128,7 +136,9 @@ Validator server under WSGI
128136
Running with Vagrant
129137
--------------------
130138

131-
For ease of development and local testing, you can provision a virtual machine using Vagrant. To start Vagrant, ssh in, and run the validator on a site::
139+
For ease of development and local testing, you can provision a virtual machine using Vagrant. To start Vagrant, ssh in, and run the validator on a site:
140+
141+
.. code-block:: shell
132142

133143
vagrant up
134144
vagrant ssh
@@ -141,9 +151,9 @@ In addition, the Vagrant configuration runs the validator as a WSGI application
141151
Running with Docker
142152
--------------------
143153

144-
```
154+
.. code-block:: shell
155+
145156
docker build -t image-validator . && docker run --rm --name image-validator -p 9001:80 image-validator:latest
146-
```
147157

148158
Then navigate to:
149159

@@ -153,7 +163,8 @@ Then navigate to:
153163
Editing this README
154164
-------------------
155165

156-
This README is in reStructuredText and not gfm because that is what pypi will render. An editor like `<http://rst.ninjs.org/>`_ is useful for editing/checking interactively.
166+
This README is in reStructuredText and not gfm because that is what pypi will render.
167+
An editor like `<https://rsted.info.ucl.ac.be/>`_ is useful for editing/checking interactively.
157168

158169
License
159170
-------

0 commit comments

Comments
 (0)