chore: updated the README
This commit is contained in:
@@ -1,2 +1,32 @@
|
|||||||
# ClaSH
|
# ClaSH
|
||||||
The ClaSH shell for my personal website
|
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
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user