From 696052a0e654604a661655689854e0d1f8744c29 Mon Sep 17 00:00:00 2001 From: Foe Date: Mon, 16 Dec 2024 17:26:08 +0100 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0343362..b7c913f 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,12 @@ Download the latest generated definitions from the build workflow action, altern - [Python](https://www.python.org/) - [Pip](https://pip.pypa.io/en/stable/installation/) - [BeautifulSoup](https://pypi.org/project/beautifulsoup4/) -2. Generate LSP definitions: - - **Windows**: - 1. Edit lines 2, 3, and 6 in `runParser.ps1`. - 2. Run the script. - - **Linux**: - 1. Edit lines 4, 5, and 8 in `runParser.sh`. - 2. Run the script. -3. Configure your workspace/LSP to point to the location of your generated definitions. +2. Generate LSP definitions:\ +The `parser.py` script will generate definitions for every method documentation HTML file in a specified directory. To make it easier to generate stubs for all method subdirectories in one go, I provide a couple helper scripts. The inputs are the same for both the powershell and the bash script. Expected inputs are: + - Path to parser.py + - Input directory (path to ElunaLuaEngine.github.io repository) + - Output directory (where the stubs will be created) + - Debug flag, optional, default false (provides some additional logging in the console) + - **Example**:\ + `runParser.ps1 c:\path\to\parser.py c:\path\to\ElunaLuaEngine.github.io\repo c:\outputDirectory [debug(default false)]` +4. Configure your workspace/LSP to point to the location of your generated definitions.