Skip to content

Commit 696052a

Browse files
authored
Update README.md
1 parent 30ce5c7 commit 696052a

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ Download the latest generated definitions from the build workflow action, altern
2929
- [Python](https://www.python.org/)
3030
- [Pip](https://pip.pypa.io/en/stable/installation/)
3131
- [BeautifulSoup](https://pypi.org/project/beautifulsoup4/)
32-
2. Generate LSP definitions:
33-
- **Windows**:
34-
1. Edit lines 2, 3, and 6 in `runParser.ps1`.
35-
2. Run the script.
36-
- **Linux**:
37-
1. Edit lines 4, 5, and 8 in `runParser.sh`.
38-
2. Run the script.
39-
3. Configure your workspace/LSP to point to the location of your generated definitions.
32+
2. Generate LSP definitions:\
33+
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:
34+
- Path to parser.py
35+
- Input directory (path to ElunaLuaEngine.github.io repository)
36+
- Output directory (where the stubs will be created)
37+
- Debug flag, optional, default false (provides some additional logging in the console)
38+
- **Example**:\
39+
`runParser.ps1 c:\path\to\parser.py c:\path\to\ElunaLuaEngine.github.io\repo c:\outputDirectory [debug(default false)]`
40+
4. Configure your workspace/LSP to point to the location of your generated definitions.

0 commit comments

Comments
 (0)