/README.md

https://github.com/sahchandler/dotfiles · Markdown · 68 lines · 50 code · 18 blank · 0 comment · 0 complexity · d93686ef6a12de72bb7d0090728f3fb8 MD5 · raw file 

    

  1. # Overview
    2. 

  2. 

  3. This repository currently holds the bare minimum set of common files that I use
    4. 

  4. in my day to day work across multiple operating systems (specifically, Windows,
    5. 

  5. Linux, and macOS).
    6. 

  6. 

  7. When setting up a new environment, this repository is typically one of the
    8. 

  8. first things I pull down when I am ready to start working.
    9. 

  9. 

  10. # Installing
    11. 

  11. 

  12. To install/setup/initialize these dotfiles, use Python 3 and run
    13. 

  13. 

  14. ```console
    15. 

  15. $ python setup.py
    16. 

  16. ```
    17. 

  17. 

  18. # Tools
    19. 

  19. 

  20. The following tools are required to get the full use out of this project:
    21. 

  21. 

  22.  - [pwsh](https://github.com/powershell/powershell)
    23. 

  23.  - [neovim](https://github.com/neovim/neovim)
    24. 

  24.  - [ripgrep](https://crates.io/crates/ripgrep)
    25. 

  25.  - [delta](https://crates.io/crates/git-delta)
    26. 

  26.  - [lsd](https://crates.io/crates/lsd)
    27. 

  27.  - [fd](https://crates.io/crates/fd-find)
    28. 

  28.  - [gh](https://github.com/cli/cli)
    29. 

  29. 

  30. The following font is used:
    31. 

  31. 

  32.  - [Delugia Code](https://github.com/adam7/delugia-code)
    33. 

  33. 

  34. # Development
    35. 

  35. 

  36. To stay in line with "best practices", a few tools are used to make sure my
    37. 

  37. dotfiles meet my personal requirements. To do this a few development tools are
    38. 

  38. used:
    39. 

  39. 

  40.  - [PSScriptAnalyzer](#)
    41. 

  41.  - [stylua](#)
    42. 

  42.  - [yamllint](#)
    43. 

  43. 

  44. # Toolbox
    45. 

  45. 

  46. Additional utilities in my toolbox include the following:
    47. 

  47. 

  48.  - [hyperfine](https://crates.io/crates/hyperfine)
    49. 

  49.  - [onefetch](https://crates.io/crates/onefetch)
    50. 

  50.  - [silicon](https://crates.io/crates/silicon)
    51. 

  51.  - [pastel](https://crates.io/crates/pastel)
    52. 

  52.  - [typos](https://crates.io/crates/typos-cli)
    53. 

  53.  - [tokei](https://crates.io/crates/tokei)
    54. 

  54.  - [hexyl](https://crates.io/crates/hexyl)
    55. 

  55.  - [ambr](https://crates.io/crates/amber)
    56. 

  56.  - [bat](https://crates.io/crates/bat)
    57. 

  57.  - [btm](https://crates.io/crates/bottom)
    58. 

  58.  - [youtube-dl](#)
    59. 

  59. 

  60.  - [golangci-lint](#)
    61. 

  61.  - [flarectl](#)
    62. 

  62.  - [task](https://taskfile.dev)
    63. 

  63.  - [dlv](#)
    64. 

  64.  - [fzf](https://github.com/junegunn/fzf)
    65. 

  65. 

  66. **NOTE**: An automatic packaging solution for all these tools to create a
    67. 

  67. repository/metapackage/installer for all these tools will be put into a
    68. 

  68. separate project at a later date.
    69.