Skip to content

Commit 4135749

Browse files
committed
README: added note about example
1 parent 44a3683 commit 4135749

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ The easiest installation approach is using `pip`_:
3030

3131
$ pip install robotremoteserver
3232

33-
Alternatively you can download the `source distributions`_, extract it, and
33+
Alternatively you can download the `source distribution`_, extract it, and
3434
install it using:
3535

3636
.. sourcecode:: bash
3737

3838
$ python setup.py install
3939

4040
.. _`pip`: http://www.pip-installer.org
41-
.. _`source distributions`: PyPI_
41+
.. _`source distribution`: PyPI_
4242

4343
Usage
4444
-----
@@ -98,3 +98,12 @@ The remote server can be gracefully stopped using three different methods:
9898
- Hitting ``Ctrl-C`` on the console where the server is running.
9999
- Sending the process ``SIGINT``, ``SIGTERM``, or ``SIGHUP`` signal.
100100
- Using ``Stop Remote Server`` keyword (unless explicitly disabled).
101+
102+
Example
103+
-------
104+
105+
The remote server project contains an `example`_ that can be studied and also
106+
executed once the library is installed. The example is also included in the
107+
`source distribution`_.
108+
109+
.. _example: https://github.com/robotframework/PythonRemoteServer/tree/master/example

0 commit comments

Comments
 (0)