From 0243eef0eb04519a492d8f5090add76c4dc9e898 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Fri, 31 Jul 2020 17:39:32 +0200 Subject: [PATCH] Add some emphasis! --- docs_source/packs/newpack.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs_source/packs/newpack.rst b/docs_source/packs/newpack.rst index df076184..e8d26be5 100644 --- a/docs_source/packs/newpack.rst +++ b/docs_source/packs/newpack.rst @@ -6,7 +6,7 @@ Creating a new Pack Prerequisites ------------------------------------ -You'll need to have `Python 3.8 `_ and `poetry `_ +You'll need to have `Python 3.8 `_ and `poetry `_ to develop Royalnet Packs. Creating the repository @@ -15,7 +15,7 @@ Creating the repository To create a new pack, create a new repository based on the `Royalnet Pack template `_ and clone it to your workspace. -After cloning the template, run ``poetry install`` to install the dependencies for the pack, creating the ``poetry.lock`` file. +After cloning the template, run ``poetry install`` to create a virtualenv and install the dependencies for the pack in it. pyproject.toml ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -102,9 +102,21 @@ As the Pack is actually a Python package, you can use ``poetry`` to add new depe Use ``poetry add packagename`` to add and install a new dependency from the PyPI. +Updating the dependencies +------------------------------------ + +You can update all your dependencies by using: ``poetry update``. + +The README.md file +------------------------------------ + +The README.md file is the first thing that users of your pack will see! + +It's recommended to describe accurately how to install and configure the pack, so other users will be able to use it too! + Publishing the pack ------------------------------------ To publish your Pack on the PyPI, run ``poetry publish --build``. -Poetry will build your Pack and upload it to the PyPI for you. +Poetry will build your Pack and upload it to the PyPI for you!