From b33e44325d0ea77c4b756ee19f0bc1967a099ee7 Mon Sep 17 00:00:00 2001 From: dece Date: Wed, 21 Aug 2024 07:58:14 +0200 Subject: [PATCH] update readme --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9994624..dc89185 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Italian Swirls 🍝 -================= +# Italian Swirls 🍝 Minimal Python language server, based on [Jedi][jedi] and [pygls][pygls]. @@ -21,8 +20,7 @@ Supported features: -Install -------- +## Install You can either clone and build the server package from this repository, or install it from PyPI: @@ -64,10 +62,19 @@ require('lspconfig.configs').italianswirls = { lspconfig.italianswirls.setup { on_attach = on_attach } ``` +### Development + +The project uses Poetry for dependency management and packaging. + +```bash +poetry install # install deps in a virtualenv +poetry run italianswirls # run the LS but it may be impractical to test +poetry build # build to wheel +``` -About ------ + +## About ### Why?