Skip to content
This repository has been archived by the owner on Feb 23, 2020. It is now read-only.

Commit

Permalink
Update example instructions for pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
reillysiemens committed Jul 30, 2019
1 parent 91b5ed3 commit 9c745c9
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions examples/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Examples of How to Use Layabout
This directory contains a bunch of examples showcasing various features of
Layabout. Getting started with all of them is roughly the same process.

Before going further, make sure you have `Pipenv`_ installed.
Before going further, make sure you have `Poetry`_ installed.

Install!
--------
Expand All @@ -13,18 +13,20 @@ In the directory of the example you want to try out, run:

.. code-block:: bash
pipenv install
python3 -m venv venv
source ./venv/bin/activate
poetry install -develop .
Thats it!

Run!
----

Now you can run the example with:
Now you can run the example just by typing:

.. code-block:: bash
pipenv run example
example
Explore
=======
Expand All @@ -46,7 +48,7 @@ A Brief Overview of Each Example
- `conditional-exit`_: Keep the event loop going until someone says the magic
words determined by the user.

.. _Pipenv: https://docs.pipenv.org/#install-pipenv-today
.. _Poetry: https://poetry.eustace.io/docs/#installation
.. _simple: simple
.. _early-connection: early-connection
.. _runtime-handler-definition: runtime-handler-definition
Expand Down

0 comments on commit 9c745c9

Please sign in to comment.