chore: updated the README

This commit is contained in:
2024-11-18 18:17:21 -07:00
parent a1ff421ff7
commit 1d4ab4a54f
+30
View File
@@ -1,2 +1,32 @@
# ClaSH
The ClaSH shell for my personal website
## Building
To build the ClaSH shell, run the following command:
```shell
cargo build --release
```
## Running
To run the ClaSH shell, you can do the following:
### Run the debug executable
```shell
cargo run
```
### Run the release executable
```shell
./target/release/clash
```
### Run the container
```shell
docker build -t clash .
docker run --rm -it -p 7681:7681 clash
```
### Run the container using docker-compose
```shell
docker compose up
```