CommandPrompt/README.md

45 lines
1.3 KiB
Markdown

# CommandPrompt
## Description
This CommandPrompt is an *highly* customised prompt for bash
![showcase](https://gitea.skadubpc.net/ulysse/CommandPrompt/src/branch/main/media/prompt%20showcase.gif)
It show the time, user, current directory and an info.
The info is an icon if pwd is in the configured special folders (see more below).
However if pwd is in the directory or sub-directory of a project, it will find by probabilities
where the project root is and show the project's folder name.
It also detect the majority language in the current directory and displays an icon depending on it !
For the moment the supported language are :
- C
- C++
- Rust
- Go
- Python
- Java
- Ruby
- Javascript
- PHP
- C#
- HTML/CSS (considered same language)
## How to install
You can install this prompt by copying the file to any directory you want (for example ~/.config/bash/)
and calling with **source** the file at the end of your .bashrc or .profile depending on your system.
If your system is in a different language you can change the special folder names direcly at the beginning
of the file.
## Internal commands
This command prompt include 2 internal command that you can call manually if you want to
manipulate cache or debug the prompt.
These are :
- find_project_root_dir
- find_dir_majority_language
For more info call them with --help.