feat: adding documentation for the theme

ohmybash · Jan 26, 2025 · 59b3988 · 59b3988
1 parent e59ce9f
commit 59b3988
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/themes/nekolight/README.md b/themes/nekolight/README.md
@@ -0,0 +1,16 @@
+# NekoLight prompt theme
+
+Nekolight is a starship-based oh my bash prompt theme designed to be simple and lightweight.
+
+## 🚀 Installation
+
+Prerequisites
+- A Nerd Font installed and enabled in your terminal (for example, try the FiraCode Nerd Font).
+
+After installing the Nerd Fonts font, just modify the following line in your ~/.bashrc
+
+```shell
+OSH_THEME="nekolight"
+```
+
+and then to load the theme in your terminal you must type `source ~/.bashrc`.
diff --git a/themes/nekolight/nekolight-dark.jpg b/themes/nekolight/nekolight-dark.jpg
diff --git a/themes/nekolight/nekolight.theme.sh b/themes/nekolight/nekolight.theme.sh
@@ -8,9 +8,9 @@ function _omb_theme_nekolight_git_info() {
     local branch=$(_omb_prompt_git symbolic-ref --short HEAD 2>/dev/null || _omb_prompt_git rev-parse --short HEAD 2>/dev/null)
 
     if _omb_prompt_git diff --quiet 2>/dev/null && _omb_prompt_git diff --cached --quiet 2>/dev/null; then
-      _omb_util_print "${_omb_prompt_bold_green}${branch} ${_omb_theme_nekolight_symbol}${_omb_prompt_normal}"
+      _omb_util_print "on ${_omb_prompt_bold_green} ${_omb_theme_nekolight_symbol} ${branch} ${_omb_prompt_normal}"
     else
-      _omb_util_print "${_omb_prompt_bold_red}${branch} ${_omb_theme_nekolight_symbol}${_omb_prompt_normal}"
+      _omb_util_print "on ${_omb_prompt_bold_red} ${_omb_theme_nekolight_symbol} ${branch}${_omb_prompt_normal}"
     fi
   fi
 }