terapines
/
circt
mirror of https://github.com/llvm/circt.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs to add configuration for VS code (#5845) 

* Update docs to add configuration for VS code

* build host instead of x86 and risc-v
This commit is contained in:
Rachit Nigam 2023-08-17 16:44:37 +05:30 committed by GitHub
parent b7d08125b8
commit cfce421982
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.vscode/Unified.code-workspace.example.jsonc vendored
View File

@ -32,7 +32,7 @@
"cmake.configureArgs": [
// LLVM
"-DLLVM_ENABLE_PROJECTS=mlir",
"-DLLVM_TARGETS_TO_BUILD=X86;RISCV",
"-DLLVM_TARGETS_TO_BUILD=host",
"-DLLVM_ENABLE_ASSERTIONS=ON",
"-DLLVM_BUILD_EXAMPLES=OFF",
"-DLLVM_ENABLE_OCAMLDOC=OFF",
@ -48,7 +48,8 @@
// Circt
"-DLLVM_EXTERNAL_PROJECTS=circt",
"-DLLVM_EXTERNAL_CIRCT_SOURCE_DIR=${workspaceFolder:CIRCT}"
"-DLLVM_EXTERNAL_CIRCT_SOURCE_DIR=${workspaceFolder:CIRCT}",
"-DCIRCT_ENABLE_LLHD_SIM=OFF",
]
},
"extensions": {

18
docs/GettingStarted.md
View File

@ -157,6 +157,24 @@ satisfiability problems. Here, it is optionally used in the static scheduling
infrastructure. Binary distributions often do not include the required CMake
build info. The `utils/get-or-tools.sh` script downloads, compiles, and
installs a known good version to a directory within the CIRCT source code,
## Setting up VS Code Workspace
We've provided an example VS Code file in `.vscode/Unified.code-workspace.jsonc` that can be used with the VS Code editor. To use the file, first copy to into a workspace file:
```sh
cp .vscode/Unified.code-workspace.jsonc .vscode/circt.code-workspace
```
Next, open the workspace file in VS code using the command palette (Ctrl + Shift + P) and selecting "Open workspace from file" and selecting the `.vscode/circt.code-workspace` file.
Alternatively, open the file using:
```
code .vscode/circt.code-workspace
```
and select "open workspace" on the bottom right.
Once the workspace is loaded, install the recommended tools and select "CMake: Build" from the command palette to start the unified build process. This will build the LLVM dependencies and CIRCT together.
where it is then picked up automatically by the build.
## Windows: notes on setting up with Ninja