Skip to content

Commit

Permalink
Adjust README
Browse files Browse the repository at this point in the history
  • Loading branch information
JuniorIsAJitterbug committed Feb 26, 2024
1 parent 7b13b71 commit dcddbfd
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,20 @@ tbc-video-export.AppImage input.tbc
```

### macOS
> [!TIP]
> You can add the application to your `PATH` by creating a symlink:
> `ln -s /Applications/tbc-video-export.app/Contents/MacOS/tbc-video-export /usr/local/bin/tbc-video-export`.
```
/Applications/tbc-video-export.app/Contents/MacOS/tbc-video-export input.tbc
tbc-video-export input.tbc
```
**Note:** You can symlink this to `/usr/local/bin`.
or (*without symlink*)
```
ln -s /Applications/tbc-video-export.app/Contents/MacOS/tbc-video-export /usr/local/bin/tbc-video-export
tbc-video-export input.tbc
/Applications/tbc-video-export.app/Contents/MacOS/tbc-video-export input.tbc
```

### PyPI
**Note:** Ensure the install location for `pip`/`pipx` is in `PATH`.
> [!IMPORTANT]
> Use `pipx ensurepath` to add the application to your `PATH`. If you install via `pip` you need to do this manually.
```
tbc-video-export input.tbc
```
Expand Down Expand Up @@ -98,4 +101,4 @@ tbc-video-export input.tbc

# Disclaimer

This is my first major Python project. There are likely bugs and code that go against best practices. If you have any comments, suggestions, or improvements, feel free to create an issue, do a pull request, or contact **Jitterbug** or **Harry** on the [Domesday86](https://discord.gg/pVVrrxd) discord.
This is my first major Python project. If you have any comments, suggestions, or improvements, feel free to create an issue, do a pull request, or contact **Jitterbug** or **Harry** on the [Domesday86](https://discord.gg/pVVrrxd) discord.

0 comments on commit dcddbfd

Please sign in to comment.