Skip to content

Commit

Permalink
Rename config.py to install.py
Browse files Browse the repository at this point in the history
  • Loading branch information
logandhillon committed Jul 25, 2024
1 parent 7518e5f commit b768d98
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 10 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,27 @@ Read the docs at 🔗 [badtechnologies.github.io/bdsh](https://badtechnologies.g

1. **Download the latest release**

Or, you can directly download `config.py` and `bdsh.py` from the [repo](https://github.com/badtechnologies/bdsh).
Or, you can directly download `install.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.
> The only file needed to create a bdsh installation is `install.py`.<br>
> Running `install.py` generates, downloads, or installs everything else.
2. **Setup bdsh:**

```sh
python3 config.py
python3 install.py
```

Follow the on-screen instructions.

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

3. **Launch bdsh:**

```sh
python3 bdsh.py
bdsh
```

> [!NOTE]
> This may change depending on how you created your launcher scripts.
2 changes: 1 addition & 1 deletion docs/file-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This document provides an overview of the file and folder structure of bdsh (Bados Dynamic Shell).

The system file structure will be created automatically with the bdsh configuration tool (config.py).
The system file structure will be created automatically with the bdsh installation tool (install.py).

## Root Directory

Expand Down
13 changes: 10 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,16 @@

1. **Download the latest release**

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

> #### 💡 Tip
> The only file needed to create a bdsh installation is `install.py`.<br>
> Running `install.py` generates, downloads, or installs everything else.
2. **Setup bdsh:**

```sh
python3 config.py
python3 install.py
```

Follow the on-screen instructions.
Expand All @@ -34,5 +38,8 @@
3. **Launch bdsh:**

```sh
python3 bdsh.py
bdsh
```

> #### ℹ️ Note
> This may change depending on how you created your launcher scripts.
File renamed without changes.

0 comments on commit b768d98

Please sign in to comment.