Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
logandhillon authored Jul 12, 2024
1 parent da56676 commit bee4086
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# BadOS Dynamic Shell (bdsh)

Read the docs at 🔗 [badtechnologies.github.io/bdsh](https://badtechnologies.github.io/bdsh).

## Installation

1. **Download the latest release**

Or, you can directly download `config.py` and `bdsh.py` from the [repo](https://github.com/badtechnologies/bdsh).

> [!TIP]
> The only files needed to run bdsh are `config.py` and `bdsh.py`.<br>
> Running `config.py` generates, downloads, or installs everything else.
2. **Setup bdsh:**

```sh
Expand All @@ -15,13 +20,11 @@ Read the docs at 🔗 [badtechnologies.github.io/bdsh](https://badtechnologies.g

Follow the on-screen instructions.

> [!NOTE]
> At least ONE user must exist for bdsh to function

Once the `/bdsh` directory and your configs are prepared, you can start bdsh with `bdsh.py` to launch the interactive shell.

3. **Launch bdsh:**

```sh
python3 bdsh.py
```

0 comments on commit bee4086

Please sign in to comment.