Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the readme #52

Merged
merged 2 commits into from
Sep 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
# shell - cross-platform bash compatible shell

The idea of the `shell` project is to build a cross-platform shell that looks and feels similar to bash (while not claiming to be 100% bash compatible).
The project is written in Rust.

The most common bash commands are implemented and we are linking with the `coreutils` crate to provide the most important Unix commands in a cross-platform, memory safe way (such as `mv`, `cp`, `ls`, `cat`, etc.).

This new shell also already has _tab completion_ for files and directories, and _history_ support thanks to `rustyline`.

The project is still very early but can already be used as a daily driver.

## How to run this

To compile and run the project, you need to have Rust installed.
To compile and run the project, you need to have Rust & Cargo installed.

```bash
cargo r -- ./scripts/script_1.sh
cargo r -- ./scripts/script_2.sh
```
# To start an interactive shell
cargo r

# To run a script
cargo r -- -f ./scripts/hello_world.sh
```
1 change: 1 addition & 0 deletions scripts/hello_world.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
echo "Hello World!"
Loading