Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation suggestions #11

Open
eddelbuettel opened this issue Dec 15, 2018 · 2 comments
Open

Documentation suggestions #11

eddelbuettel opened this issue Dec 15, 2018 · 2 comments

Comments

@eddelbuettel
Copy link

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
Copy link
Contributor

arcticicestudio commented Dec 17, 2018

Thanks for your contribution 👍
Glad to see you like the theme 😄

  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 Documentation and/or support for MacOS #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
Copy link
Author

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.

@arcticicestudio arcticicestudio added the Hacktoberfest This repository participates in the Hacktoberfest label Oct 8, 2020
@arcticicestudio arcticicestudio removed the Hacktoberfest This repository participates in the Hacktoberfest label Nov 13, 2020
arcticicestudio pushed a commit that referenced this issue Nov 29, 2020
Removed the quotes from around `~/.dir_colors` in the installation
instructions. Before the shell specific tilde character was not resolved
via variable expansion but used as literal character instead. 

Co-authored-by: Arctic Ice Studio <[email protected]>
Co-authored-by: Sven Greb <[email protected]>

Fixes GH-15
Fixes GH-18
Related to GH-11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants