search

nordtheme / dircolors

An arctic, north-bluish clean and elegant dircolors theme.
https://www.nordtheme.com/ports/dircolors
MIT License
523 stars 104 forks source link

Documentation suggestions #11

Open eddelbuettel opened 5 years ago

eddelbuettel commented 5 years ago

Nord is amazing! Tweeted about it yesterday but forgot to CC your handle. Seems to strike a chord!

Two quick suggestions for nord-dircolors

  1. My ~/.bashrc has the line test -r ~/.dircolors && eval "$(dircolors -b ~/.dircolors)" || eval "$(dircolors -b)" so maybe this should install to ~/.dircolors and/or offer a soft link?
  2. Might be worthwhile to remind people that /usr/bin/dircolors is needed to create LS_COLORS or else nothing happens?
arcticicestudio commented 5 years ago

Thanks for your contribution :+1: Glad to see you like the theme :smile:

  1. The provided install.sh script will install the file to ~/.dircolors, but your Bash profile statements are a nice way for the usage documentation. Also a nice improvement would be to use a symlink instead of just copying the file so e.g. we could create a folder $XDG_CONFIG_DIRS/nord-dircolors, place the file in it and symlink it to ~/.dircolors.
  2. Well, it's kind of a soft dependency to ensure the upstream/target application is installed when using a color theme for it, but we can add it to the documentation along with the improvements from #7 for the differences between Linux and macOS. dircolors is part of the GNU coreutils so the chance many users might run into this is low.

Feel free to submit a PR to add these improvements, but I've also added it to my TODO list for the official Nord Docs I work on for some months now with the goal to finally have a single-source-of-truth for all of Nord's port projects.

eddelbuettel commented 5 years ago

Using $XDG_CONFIG_DIRS and linking back is good, as is the plan to document the eval use. For now I'll try the same with a local 'dotfiles' git repo I have.