Add note about installing with idleuserextend

CoolCat467 · Oct 18, 2023 · 01a7ace · 01a7ace
1 parent 8c97c00
commit 01a7ace
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,16 @@ Python IDLE extension to align code by a regular expression
 
 <!-- END BADGIE TIME -->
 
-## Installation
+## Installation (Without root permissions)
+1) Go to terminal and install with `pip install idlealign[user]`.
+2) Run command `idleuserextend; idlealign`. You should see the following
+output: `Config should be good! Config should be good!`.
+3) Open IDLE, go to `Options` -> `Configure IDLE` -> `Extensions`.
+If everything went well, alongside `ZzDummy` there should be and
+option called `idlealign`. This is where you can configure how
+idlealign works.
+
+## Installation (Legacy, needs root permission)
 1) Go to terminal and install with `pip install idlealign`.
 2) Run command `idlealign`. You will likely see a message saying
 `idlealign not in system registered extensions!`. Run the command

diff --git a/pyproject.toml b/pyproject.toml
@@ -41,7 +41,7 @@ user = ["idleuserextend~=0.0.0"]
 idlealign = "idlealign:check_installed"
 
 [tool.setuptools.package-data]
-sanescansrv = ["py.typed"]
+idlealign = ["py.typed"]
 
 [tool.mypy]
 mypy_path = "src"