Skip to content

Commit

Permalink
Fix: comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Jiaaming committed Jul 24, 2024
1 parent 88c5f35 commit 98b1d49
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
34 changes: 18 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,34 @@ Start by opening an issue using one of the issue templates, or propose a change

## Running the Project

### Build Gradle Project Importer
Before proceeding with the build steps for Gradle Server , you need to build the Gradle Project Importer first.

1. Install [Java version >= 17](https://adoptium.net/)
2. `cd extension`
3. `git clone https://github.com/microsoft/build-server-for-gradle.git `
4. Build the Importer and Build Server jars: `../gradlew buildJars`

### Build Gradle Server
After building the Gradle Project Importer, proceed with the following steps.

### Prerequisites
1. Install [nvm](https://github.com/nvm-sh/nvm)
2. Install [Java version >= 17](https://adoptium.net/)
3. Change directory to the root of the project
4. Select Node version: `nvm use`
5. If using an Apple M1:
3. Select Node version: `nvm use`
4. If using an Apple M1:
- Add `npm_arch=x64` to $HOME/.gradle/gradle.properties
- Add `protoc_platform=osx-x86_64` to $HOME/.gradle/gradle.properties
6. If using Windows:
5. If using Windows:
- The extension uses `[email protected]` dependency which does not work out-of-the-box in Windows (check [this issues](https://github.com/grpc/grpc-node/issues/2338) for details), so you'll need to install some aditional DLLs if the project build is failed.
- Download and start [Build Tools for Visual Studio 2022](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022).
- Go to the **Individual Components** tab and select the following:
- `MSVC v143 - VS 2022 C++ x64/x86 build tools (latest)` (replacing `x64/x86` with your arch)
- `Windows Universal CRT SDK`
- Click `Install` to add the components.
7. Build project files: `./gradlew build`

### Build Gradle Build Server & Gradle Project Importer
Before proceeding with the build steps for Build Task Server & Language Server, you need to build the Gradle Build Server and its client (Gradle Project Importer) first.

1. `cd extension`
2. `git clone https://github.com/microsoft/build-server-for-gradle.git `
3. Build the Importer and Build Server jars: `../gradlew buildJars`

### Build Task Server & Language Server
After building the Gradle Build Server and its client, proceed with the following steps.

1. Change directory to the root of the project

2. Build project files: `./gradlew build`

Running the build for the first time can take a bit of time, but subsequent builds should be fast.

Expand Down
1 change: 1 addition & 0 deletions gradle-server/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ task serverStartScripts(type: CreateStartScripts) {
}

task copyRuntimeLibs(type: Copy) {
delete libsDir
into "../extension/lib"
from configurations.runtimeClasspath
duplicatesStrategy = 'exclude'
Expand Down

0 comments on commit 98b1d49

Please sign in to comment.