Skip to content

Commit 336e050

Browse files
committed
docs: Add details on poetry
1 parent ddaeec6 commit 336e050

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

docs/developing.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ using ``$ tmux -L test_case``.
2020
Install the latest code from git
2121
--------------------------------
2222

23-
Using pip
24-
^^^^^^^^^
23+
Get the source
24+
^^^^^^^^^^^^^^
2525

2626
To begin developing, check out the code from github:
2727

@@ -30,6 +30,9 @@ To begin developing, check out the code from github:
3030
$ git clone git@github.com:tmux-python/tmuxp.git
3131
$ cd tmuxp
3232
33+
Advanced: Manual virtual
34+
^^^^^^^^^^^^^^^^^^^^^^^^
35+
3336
Now create a virtualenv, if you don't know how to, you can create a
3437
virtualenv with:
3538

@@ -57,8 +60,12 @@ adjust the code and the installed software will reflect the changes.
5760
5861
$ tmuxp
5962
60-
Using poetry
61-
^^^^^^^^^^^^
63+
Simple: Using poetry
64+
^^^^^^^^^^^^^^^^^^^^
65+
66+
The easiest way to configure a dev environment is through `poetry`_. This
67+
automatically will manage virtualenv and python dependencies for tmuxp.
68+
For information on installing poetry visit the `poetry's documentation`_.
6269

6370
To begin developing, check out the code from github:
6471

@@ -91,6 +98,8 @@ Then activate it to your current tty / terminal session with:
9198
9299
That is it! You are now ready to code!
93100

101+
.. _poetry: https://python-poetry.org/
102+
.. _poetry's documentation: https://python-poetry.org/docs/
94103

95104
Test Runner
96105
-----------

0 commit comments

Comments
 (0)