Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update wsl setup doc #867

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -130,27 +130,29 @@ jobs:
- name: "Validate changelog.xml"
run: "python -u -c 'import xmlschema; xmlschema.XMLSchema(\"schemas/changes-1.0.0.xsd\").validate(\"changelog.xml\")'"

- name: "Validate JSON files"
run: "python -u tools/validateJsonFiles.py"
# No need to validate JSON files
# even if wants to, should do it locally
# - name: "Validate JSON files"
# run: "python -u tools/validateJsonFiles.py"

analyzeCodeQl:
name: "CI - CodeQL Job"
runs-on: "ubuntu-20.04"

steps:
- name: "Checkout Repository"
uses: "actions/checkout@v2"
uses: "actions/checkout@v4"

- name: "Initialize CodeQL"
uses: "github/codeql-action/init@v1"
uses: "github/codeql-action/init@v2"
with:
languages: "javascript,python"

- name: "Autobuild"
uses: "github/codeql-action/autobuild@v1"
uses: "github/codeql-action/autobuild@v2"

- name: "Perform CodeQL Analysis"
uses: "github/codeql-action/analyze@v1"
uses: "github/codeql-action/analyze@v2"

deployForVsCode:
name: "CI - Deploy for VS Code Job"
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
/.vscode/settings.json

!/lib/.keep
/.venv
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,28 @@ If you like LT<sub>E</sub>X, but are not able to contribute in any of these ways
5. Install the npm dependencies: `cd vscode-ltex && npm install`
6. Run the `Launch extension` task to launch and debug the extension.

### Setup Windows WSL env

`Python` is required to develop this project. For reference you can check out [Get started using Python for web development on Windows](https://learn.microsoft.com/en-us/windows/python/web-frameworks).

```sh
sudo apt update && sudo apt upgrade

sudo apt install libxshmfence1 libnss3 libatk1.0-0 libatk-bridge2.0-0 librust-gdk-pixbuf-sys-dev libgtk-3-0 libgbm1 libasound2 openjdk-21-jdk

sudo apt upgrade python3

sudo apt install python3-pip

# optional
sudo apt install python3-venv

# required as python2 is deprecated
sudo apt install python-is-python3

pip install semver jsonschema
```

## How to Contribute Code

1. [Set up the project.](#how-to-set-up-the-project)
Expand Down