Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Foereaper authored Dec 16, 2024
1 parent 30ce5c7 commit 696052a
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 696052a

Please sign in to comment.