Skip to content

Commit

Permalink
markdownlint fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
pront committed Jul 3, 2023
1 parent 4087f15 commit 5ee40d7
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
6 changes: 6 additions & 0 deletions lib/vector-vrl/web-playground/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ For more information on Rust and WebAssembly please visit
[the Rust book wasm chapter][rust-book-wasm]

## Run locally

The `src/lib.rs` file is the entry point of the `web-playground` crate.
This file is necessary so we can use the `run_vrl()` function in the browser.
Notice our `index.html` imports the VRL wasm module from `./vrl_web_playground.js`
Expand Down Expand Up @@ -69,20 +70,24 @@ Functions from VRL stdlib that are currently not supported can be found
with this [issue filter][vrl-wasm-unsupported-filter].

### macOS Troubleshooting

If you are getting compilation errors on macOS here are some things to check:

```shell
xcode-select -p
# Example: '/Library/Developer/CommandLineTools
# To change this use: xcode-select -s
```

You can clean and reinstall with:

```shell
rm -rf /Library/Developer/CommandLineTools # might require sudo elevation
xcode-select --install
```

Check your `llvm` installation and ensure that there are no conflicting installations. Check that the following command returns the expected version:

```shell
clang --version
# Example:
Expand All @@ -93,6 +98,7 @@ clang --version
```

The output of the following command should contain `WebAssembly`:

```shell
llvm-config --targets-built # WebAssembly should be in the results
# Example: AArch64 <omitted> WebAssembly <omitted>
Expand Down
4 changes: 3 additions & 1 deletion lib/vector-vrl/web-playground/public/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,10 @@ probably under a different package name.
Use this dependency in `package.json`

```json
"dependencies": {
{
"dependencies": {
"vrl-web-playground": "0.1.0"
}
}
```

Expand Down

0 comments on commit 5ee40d7

Please sign in to comment.