93 lines
2.4 KiB
Markdown
93 lines
2.4 KiB
Markdown
|
# term-header
|
||
|
|
|
||
|
|
`term-header` is a Rust-based command-line tool that generates customizable ASCII art terminal headers. These headers can be added to your .bashrc or other startup files to personalize the appearance of your terminal each time it starts.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- **Customizable Headers:** Use ASCII art files to create unique headers.
|
||
|
|
- **Color Options:** Specify text color for your headers (note that terminal themes may cause unexpected behavior).
|
||
|
|
- **Flexible Paths:** Configure paths for titles, art, and banners.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
### From Source
|
||
|
|
|
||
|
|
1. Ensure you have Rust installed. If not, you can install it from [rust-lang.org](https://www.rust-lang.org/learn/get-started).
|
||
|
|
|
||
|
|
2. Clone the repository:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
git clone https://vcs.r0r-5chach.xyz/r0r-5chach/term-header.git
|
||
|
|
cd term-header
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Build the project:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
cargo build --release
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Optionally, install the binary globally:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
cargo install --path .
|
||
|
|
```
|
||
|
|
|
||
|
|
### Using Pre-built Binaries
|
||
|
|
|
||
|
|
Check the [Releases](https://vcs.r0r-5chach.xyz/r0r-5chach/term-header/releases) page for pre-built binaries.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Run term-header with the following options:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
|
||
|
|
term-header [OPTIONS]
|
||
|
|
|
||
|
|
Options
|
||
|
|
|
||
|
|
-t, --titles-path <TITLES_PATH>
|
||
|
|
The path to the ASCII text files directory (default: ./titles/).
|
||
|
|
|
||
|
|
-a, --art-path <ART_PATH>
|
||
|
|
The path to the ASCII image files directory (default: ./art/).
|
||
|
|
|
||
|
|
-b, --banner-path <BANNER_PATH>
|
||
|
|
The path to the ASCII banner (default: ./banner.txt).
|
||
|
|
|
||
|
|
-c, --color <COLOR>
|
||
|
|
The color the text should be outputted as. Note that terminal themes can cause unexpected behavior.
|
||
|
|
|
||
|
|
-h, --help
|
||
|
|
Print help information.
|
||
|
|
|
||
|
|
-V, --version
|
||
|
|
Print the version number.
|
||
|
|
```
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
Add a simple header to your terminal startup by configuring your .bashrc:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
|
||
|
|
# Add this line to your .bashrc
|
||
|
|
term-header -t ./path/to/titles/ -a ./path/to/art/ -b ./path/to/banner.txt -c green
|
||
|
|
```
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Contributions are welcome! If you have suggestions, issues, or feature requests, please open an issue or submit a pull request.
|
||
|
|
|
||
|
|
1. Fork the repository.
|
||
|
|
2. Create a new branch (git checkout -b feature/your-feature).
|
||
|
|
3. Make your changes.
|
||
|
|
4. Commit your changes (git commit -am 'Add some feature').
|
||
|
|
5. Push to the branch (git push origin feature/your-feature).
|
||
|
|
6. Create a new Pull Request.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project is licensed under the MIT License. See the LICENSE file for more details.
|