From 51ada74dbe8227eb7a50efbaaf77e18cf230f724 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 25 May 2024 21:07:25 +0000 Subject: [PATCH] docs: auto-update README --- .github/README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/README.md diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..441b26a --- /dev/null +++ b/.github/README.md @@ -0,0 +1,42 @@ +# Windows Configuration Files + +These used to live alongside my main +[Dotfiles](https://github.com/julianorchard/dotfiles), but I don't use Windows +enough to need them in there anymore. + +## Scripts + +Some of the scripts have descriptions and some of those descriptions are listed +below: + +### cmdrc.bat [file](/.bin/cmdrc.bat) + +This is a method of having a custom prompt in CMD. It's opened by AutoHotkey (see ahk/general.ahk for more information). + +### commit.ps1 [file](/.bin/commit.ps1) + +Should be thought of as a temporary tool until used to doing it by default! Reminder text from this Gist: https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716 + +### config.bat [file](/.bin/config.bat) + +The command used to manage the bare repo: ```cmd git --git-dir=%HOME%/.dotfiles/ --work-tree=%HOME% ``` ... for use in the Windows CMD. + +### drives.bat [file](/.bin/drives.bat) + +Add shortcuts to available drives. + +### ll.bat [file](/.bin/ll.bat) + +`dir` isn't it my muscle memory at all. + +### refreshprompt.bat [file](/.bin/refreshprompt.bat) + +The main use case for this being whenever we change Git profiles. This isn't something I do as often as I used to. + +### shortcuts.bat [file](/.bin/shortcuts.bat) + +Use this script to create a shortcut to the current folder you're in. I've found this especially useful for CMD navigation. + +## License + +[MTI](/LICENSE).