Skip to content

Commit 81ca31e

Browse files
docs: update README.md
- remove Makefile commands table - fix sub-heading Windows -> Windows (Powershell)
1 parent c68f512 commit 81ca31e

1 file changed

Lines changed: 1 addition & 14 deletions

File tree

README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,6 @@ You will need `make` installed on your system.
5151
If you do not want to install make (make is provided in the Nix shell environment)
5252
or don't have it installed, you can use the commands specified in the [`Makefile`](./Makefile).
5353

54-
| Command | Description |
55-
| ----------------- | ----------------------------------------------------------------------------------------------------- |
56-
| make build | Builds the project using `zig build`, the executable can be found in `./zig-out/bin/cpplings` |
57-
| make run | Build the project like `zig build` then runs the executable |
58-
| make nix | Starts the Nix development environment |
59-
| make docker-build | Builds a local Docker image |
60-
| make docker-run | Starts a container using the `cpplings` image and mounts a volume to the path of the clone repository |
61-
| make docker-exec | Executes and enters the bash shell of the container and `/cpplings` directory |
62-
| make docker-stop | Stops the container |
63-
| make docker-rm | Removed the container |
64-
| make format | Format the entire codebase with [`treefmt`](https://github.com/numtide/treefmt) |
65-
| make lint | Lint codebase with `treefmt` |
66-
6754
### Native Package Manager
6855

6956
If you would like to compile using your own package manager; `homebrew`, `pacman`, `apt`, etc.
@@ -193,7 +180,7 @@ make docker-run
193180
> docker exec -it -w "/cpplings" cpplings bash
194181
> ```
195182
>
196-
> #### Windows
183+
> #### Windows (Powershell)
197184
>
198185
> ```ps1
199186
> # change CPPLINGS_DIR to your liking \

0 commit comments

Comments
 (0)