Skip to content

Commit 769595a

Browse files
authored
Remove $ from README command blocks for easier copy-paste (#589)
1 parent 6dbccb5 commit 769595a

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ This repo uses [Go 1.24 or higher](https://go.dev/dl/), [Node.js with npm](https
1212
For tests and code generation, this repo contains a git submodule to the main TypeScript repo pointing to the commit being ported.
1313
When cloning, you'll want to clone with submodules:
1414

15-
```console
16-
$ git clone --recurse-submodules https://github.com/microsoft/typescript-go.git
15+
```sh
16+
git clone --recurse-submodules https://github.com/microsoft/typescript-go.git
1717
```
1818

1919
If you have already cloned the repo, you can initialize the submodule with:
2020

21-
```console
22-
$ git submodule update --init --recursive
21+
```sh
22+
git submodule update --init --recursive
2323
```
2424

2525
With the submodule in place and `npm ci`, you can run tasks via `hereby`, similar to the TypeScript repo:
2626

27-
```console
28-
$ hereby build # Verify that the project builds
29-
$ hereby test # Run all tests
30-
$ hereby install-tools # Install additional tools such as linters
31-
$ hereby lint # Run all linters
32-
$ hereby format # Format all code
33-
$ hereby generate # Generate all Go code (e.g. diagnostics, committed to repo)
27+
```sh
28+
hereby build # Verify that the project builds
29+
hereby test # Run all tests
30+
hereby install-tools # Install additional tools such as linters
31+
hereby lint # Run all linters
32+
hereby format # Format all code
33+
hereby generate # Generate all Go code (e.g. diagnostics, committed to repo)
3434
```
3535

3636
Additional tasks are a work in progress.

0 commit comments

Comments
 (0)