@sebastienrousseau/dotfiles 0.2.464 → 0.2.466

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. package/LICENSE +20 -17
  2. package/README.md +210 -382
  3. package/dist/Makefile +2 -2
  4. package/dist/bin/constants.d.ts +2 -2
  5. package/dist/bin/constants.d.ts.map +1 -1
  6. package/dist/bin/constants.js +1 -1
  7. package/dist/bin/constants.js.map +1 -1
  8. package/dist/filesizes.txt +170 -144
  9. package/dist/lib/README.md +6 -1
  10. package/dist/lib/aliases/README.md +51 -0
  11. package/dist/lib/aliases/archives/README.md +39 -67
  12. package/dist/lib/aliases/archives/archives.aliases.sh +128 -60
  13. package/dist/lib/aliases/cd/README.md +26 -9
  14. package/dist/lib/aliases/cd/cd.aliases.sh +1 -4
  15. package/dist/lib/aliases/chmod/README.md +48 -13
  16. package/dist/lib/aliases/chmod/chmod.aliases.sh +1 -1
  17. package/dist/lib/aliases/clear/README.md +33 -38
  18. package/dist/lib/aliases/clear/clear.aliases.sh +35 -33
  19. package/dist/lib/aliases/configuration/README.md +26 -37
  20. package/dist/lib/aliases/configuration/configuration.aliases.sh +40 -36
  21. package/dist/lib/aliases/default/README.md +26 -52
  22. package/dist/lib/aliases/default/default.aliases.sh +105 -44
  23. package/dist/lib/aliases/dig/README.md +23 -40
  24. package/dist/lib/aliases/dig/dig.aliases.sh +26 -29
  25. package/dist/lib/aliases/disk-usage/README.md +32 -0
  26. package/dist/lib/aliases/disk-usage/du.aliases.sh +84 -0
  27. package/dist/lib/aliases/editor/README.md +35 -33
  28. package/dist/lib/aliases/editor/editor.aliases.sh +13 -39
  29. package/dist/lib/aliases/find/README.md +42 -29
  30. package/dist/lib/aliases/find/find.aliases.sh +52 -26
  31. package/dist/lib/aliases/gcloud/README.md +59 -148
  32. package/dist/lib/aliases/gcloud/gcloud.aliases.sh +327 -138
  33. package/dist/lib/aliases/git/README.md +149 -0
  34. package/dist/lib/aliases/git/git.aliases.sh +535 -131
  35. package/dist/lib/aliases/gnu/README.md +85 -0
  36. package/dist/lib/aliases/gnu/gnucoreutils-aliases.sh +143 -109
  37. package/dist/lib/aliases/heroku/README.md +426 -0
  38. package/dist/lib/aliases/heroku/heroku.aliases.sh +1047 -288
  39. package/dist/lib/aliases/interactive/README.md +43 -0
  40. package/dist/lib/aliases/interactive/interactive.aliases.sh +48 -9
  41. package/dist/lib/aliases/jekyll/README.md +37 -0
  42. package/dist/lib/aliases/jekyll/jekyll.aliases.sh +49 -10
  43. package/dist/lib/aliases/list/README.md +38 -0
  44. package/dist/lib/aliases/list/list.aliases.sh +81 -30
  45. package/dist/lib/aliases/macOS/README.md +38 -0
  46. package/dist/lib/aliases/macOS/macos.aliases.sh +65 -0
  47. package/dist/lib/aliases/make/README.md +28 -0
  48. package/dist/lib/aliases/make/make.aliases.sh +30 -10
  49. package/dist/lib/aliases/mkdir/README.md +26 -0
  50. package/dist/lib/aliases/mkdir/mkdir.aliases.sh +24 -8
  51. package/dist/lib/aliases/npm/README.md +37 -0
  52. package/dist/lib/aliases/npm/npm.aliases.sh +54 -17
  53. package/dist/lib/aliases/permission/README.md +43 -0
  54. package/dist/lib/aliases/permission/permission.aliases.sh +73 -0
  55. package/dist/lib/aliases/pnpm/README.md +49 -0
  56. package/dist/lib/aliases/pnpm/pnpm.aliases.sh +70 -36
  57. package/dist/lib/aliases/ps/README.md +25 -0
  58. package/dist/lib/aliases/ps/ps.aliases.sh +14 -6
  59. package/dist/lib/aliases/rsync/README.md +21 -0
  60. package/dist/lib/aliases/rsync/rsync.aliases.sh +10 -4
  61. package/dist/lib/aliases/rust/README.md +57 -0
  62. package/dist/lib/aliases/rust/rust.aliases.sh +116 -39
  63. package/dist/lib/aliases/subversion/README.md +62 -0
  64. package/dist/lib/aliases/subversion/subversion.aliases.sh +4 -3
  65. package/dist/lib/aliases/sudo/README.md +23 -0
  66. package/dist/lib/aliases/sudo/sudo.aliases.sh +15 -6
  67. package/dist/lib/aliases/tmux/README.md +27 -0
  68. package/dist/lib/aliases/tmux/tmux.aliases.sh +29 -10
  69. package/dist/lib/aliases/update/README.md +34 -0
  70. package/dist/lib/aliases/update/update.aliases.sh +57 -26
  71. package/dist/lib/aliases/uuid/README.md +20 -0
  72. package/dist/lib/aliases/uuid/uuid.aliases.sh +13 -4
  73. package/dist/lib/aliases/wget/README.md +23 -0
  74. package/dist/lib/aliases/wget/wget.aliases.sh +15 -6
  75. package/dist/lib/aliases.sh +4 -3
  76. package/dist/lib/configurations/README.md +13 -2
  77. package/dist/lib/configurations/bash/bashrc +4 -3
  78. package/dist/lib/configurations/curl/curlrc +2 -2
  79. package/dist/lib/configurations/default/color.sh +3 -2
  80. package/dist/lib/configurations/default/constants.sh +4 -3
  81. package/dist/lib/configurations/default/editor.sh +3 -2
  82. package/dist/lib/configurations/default/prompt.sh +3 -2
  83. package/dist/lib/configurations/input/inputrc +2 -2
  84. package/dist/lib/configurations/nano/nanorc +2 -2
  85. package/dist/lib/configurations/profile/profile +2 -2
  86. package/dist/lib/configurations/tmux/default +2 -2
  87. package/dist/lib/configurations/tmux/display +6 -2
  88. package/dist/lib/configurations/tmux/linux +2 -2
  89. package/dist/lib/configurations/tmux/navigation +2 -2
  90. package/dist/lib/configurations/tmux/panes +2 -2
  91. package/dist/lib/configurations/tmux/theme +3 -3
  92. package/dist/lib/configurations/tmux/tmux +2 -2
  93. package/dist/lib/configurations/tmux/vi +2 -2
  94. package/dist/lib/configurations/vim/vimrc +1 -1
  95. package/dist/lib/configurations/wget/wgetrc +2 -2
  96. package/dist/lib/configurations/zsh/zshrc +2 -2
  97. package/dist/lib/configurations.sh +4 -3
  98. package/dist/lib/functions/README.md +73 -2
  99. package/dist/lib/functions/cdls.sh +3 -2
  100. package/dist/lib/functions/curlheader.sh +3 -2
  101. package/dist/lib/functions/curlstatus.sh +17 -0
  102. package/dist/lib/functions/curltime.sh +4 -3
  103. package/dist/lib/functions/encode64.sh +3 -2
  104. package/dist/lib/functions/environment.sh +3 -2
  105. package/dist/lib/functions/extract.sh +3 -2
  106. package/dist/lib/functions/filehead.sh +1 -1
  107. package/dist/lib/functions/freespace.sh +21 -0
  108. package/dist/lib/functions/genpwd.sh +33 -7
  109. package/dist/lib/functions/goto.sh +3 -2
  110. package/dist/lib/functions/hidehiddenfiles.sh +3 -2
  111. package/dist/lib/functions/hostinfo.sh +3 -2
  112. package/dist/lib/functions/hstats.sh +3 -2
  113. package/dist/lib/functions/httpdebug.sh +3 -2
  114. package/dist/lib/functions/keygen.sh +20 -13
  115. package/dist/lib/functions/last.sh +3 -2
  116. package/dist/lib/functions/logout.sh +3 -2
  117. package/dist/lib/functions/lowercase.sh +3 -2
  118. package/dist/lib/functions/matrix.sh +15 -14
  119. package/dist/lib/functions/mount_read_only.sh +3 -2
  120. package/dist/lib/functions/myproc.sh +4 -3
  121. package/dist/lib/functions/prependpath.sh +3 -2
  122. package/dist/lib/functions/ql.sh +3 -2
  123. package/dist/lib/functions/rd.sh +3 -2
  124. package/dist/lib/functions/remove_disk.sh +3 -2
  125. package/dist/lib/functions/ren.sh +3 -2
  126. package/dist/lib/functions/showhiddenfiles.sh +3 -2
  127. package/dist/lib/functions/size.sh +3 -2
  128. package/dist/lib/functions/stopwatch.sh +4 -3
  129. package/dist/lib/functions/uppercase.sh +3 -2
  130. package/dist/lib/functions/view-source.sh +3 -2
  131. package/dist/lib/functions/vscode.sh +3 -2
  132. package/dist/lib/functions/whoisport.sh +3 -2
  133. package/dist/lib/functions/zipf.sh +3 -2
  134. package/dist/lib/functions.sh +4 -3
  135. package/dist/lib/history.sh +4 -4
  136. package/dist/lib/paths/ant/ant.paths.sh +3 -2
  137. package/dist/lib/paths/default/default.paths.sh +3 -2
  138. package/dist/lib/paths/homebrew/homebrew.paths.sh +3 -2
  139. package/dist/lib/paths/java/java.paths.sh +3 -2
  140. package/dist/lib/paths/maven/maven.paths.sh +3 -2
  141. package/dist/lib/paths/node/node.paths.sh +3 -2
  142. package/dist/lib/paths/nvm/nvm.paths.sh +3 -2
  143. package/dist/lib/paths/pnpm/pnpm.paths.sh +3 -2
  144. package/dist/lib/paths/python/python.paths.sh +3 -2
  145. package/dist/lib/paths/ruby/ruby.paths.sh +3 -2
  146. package/dist/lib/paths/tmux/tmux.paths.sh +3 -2
  147. package/dist/lib/paths.sh +4 -3
  148. package/dist/scripts/backup.sh +3 -2
  149. package/dist/scripts/banner.sh +3 -2
  150. package/dist/scripts/build.sh +3 -2
  151. package/dist/scripts/clean.sh +3 -2
  152. package/dist/scripts/compile.sh +3 -2
  153. package/dist/scripts/copy.sh +3 -2
  154. package/dist/scripts/dotfiles.sh +3 -2
  155. package/dist/scripts/download.sh +3 -2
  156. package/dist/scripts/help.sh +3 -2
  157. package/dist/scripts/ssh.sh +3 -2
  158. package/dist/scripts/unpack.sh +3 -2
  159. package/package.json +7 -7
  160. package/dist/lib/aliases/du/README.md +0 -35
  161. package/dist/lib/aliases/du/du.aliases.sh +0 -37
  162. package/dist/lib/functions/changediskpwd.tmp +0 -19
  163. package/dist/lib/functions/code.tmp +0 -18
  164. package/dist/lib/functions/countdown.tmp +0 -34
  165. package/dist/lib/functions/headers.tmp +0 -4
  166. package/dist/lib/functions/history-all.tmp +0 -8
  167. package/dist/lib/functions/macos.sh +0 -47
  168. package/dist/lib/functions/mcd.tmp +0 -19
  169. package/dist/lib/functions/print.tmp +0 -14
  170. package/dist/lib/functions/rm.tmp +0 -14
  171. package/dist/lib/functions/rps.tmp +0 -104
  172. package/dist/lib/functions/trash.tmp +0 -14
  173. package/dist/lib/functions/tree.tmp +0 -14
  174. package/dist/lib/functions/uuidgen.tmp +0 -28
package/README.md CHANGED
@@ -1,112 +1,139 @@
1
- # Dotfiles
1
+ <!-- markdownlint-disable MD033 MD041 -->
2
2
 
3
- [![Banner representing the Dotfiles Library][logo]][website-url]
3
+ <img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg"
4
+ alt="dotfiles logo" width="261" align="right" />
4
5
 
5
- [![Codacy][codacy-grade]][codacy-url]
6
- [![Contributors][contributors-shield]][contributors-url]
7
- [![Forks][forks-shield]][forks-url]
8
- [![License][license]][license-url]
9
- [![Love][love]][website-url]
6
+ <!-- markdownlint-enable MD033 MD041 -->
10
7
 
11
- **[Website][website-url] [Documentation][github-url]
12
- • [Report Bug][issues-url]
13
- • [Request Feature][issues-url]
14
- • [Contributing Guidelines][contributing-url]**
8
+ # Dotfiles (v0.2.466)
15
9
 
16
- ## 👋 Welcome to Dotfiles (v0.2.464)
10
+ Simply designed to fit your shell life 🐚
17
11
 
18
- ### Simply designed to fit your shell life
12
+ <!-- markdownlint-disable MD033 MD041 -->
13
+ <center>
14
+ <!-- markdownlint-enable MD033 MD041 -->
19
15
 
20
- Dotfiles are a set of macOS, Linux and Windows configuration files. They are
21
- aimed at making your life easier by providing a set of scripts and configuration
22
- files with new ways to get things done.
16
+ ![Dotfiles banner][banner]
23
17
 
24
- [![Getting Started][getting_started]][getting-started-url]
25
- [![Download Dotfiles v0.2.464][download_button]][download-url]
18
+ [![Codacy][codacy-grade]][06]
19
+ [![Contributors][contributors-shield]][14]
20
+ [![Forks][forks-shield]][13]
21
+ [![License][license]][02]
22
+ [![Love][love]][00]
26
23
 
27
- Dotfiles aggregates a collection of standalone configuration files (dotfiles)
28
- combined into a `lib` directory that can be used to customize your development
29
- environment across numerous computers and operating systems (macOS, Windows,
30
- Linux).
24
+ [Website][00] [Documentation][16]
25
+ [Report Bug][17] [Request Feature][17]
26
+ [Contributing Guidelines][05]
31
27
 
32
- The Dotfiles provides modular configuration files (aliases, functions and paths)
33
- built for speed, higher performance, with the aim of helping you have an easy
34
- and centralized way to configure your environment and applications.
28
+ <!-- markdownlint-disable MD033 MD041 -->
29
+ </center>
30
+ <!-- markdownlint-enable MD033 MD041 -->
35
31
 
36
32
  ![divider][divider]
37
33
 
38
- ## 💼 Documentation
34
+ ## Overview 📖
39
35
 
40
- To read the documentation for Dotfiles, please visit:
36
+ Dotfiles are a powerful set of configuration files for macOS, Linux, and
37
+ Windows providing scripts and customized settings to streamline your
38
+ workflow. These files are an essential tool for developers and users who
39
+ want to modify their environment and applications to their exact needs.
40
+
41
+ The Dotfiles library are combined into a single `lib` directory. This
42
+ directory allows you to easily setup your development environment across
43
+ numerous computers and operating systems, ensuring consistency and
44
+ productivity no matter where you work.
41
45
 
42
- - [Dotfiles website][website-url]
43
- - [Dotfiles Docs GitHub repository][docs-url]
46
+ <!-- markdownlint-disable MD033 MD041 -->
47
+ <br>
48
+ <center>
49
+ <!-- markdownlint-enable MD033 MD041 -->
50
+
51
+ [![Getting Started][getting_started]][getting-started-url]
52
+ [![Download Dotfiles v0.2.466][download_button]][12]
53
+
54
+ <!-- markdownlint-disable MD033 MD041 -->
55
+ </center>
56
+ <br />
57
+ <!-- markdownlint-enable MD033 MD041 -->
58
+
59
+ ## Features ✨
60
+
61
+ - A familiar feel and comforts across environments.
62
+ - A unified set of aliases and useful commands for macOS, Linux, and
63
+ Windows.
64
+ - Coloured multiplexer tmux prompt, customizable, and easy to use.
65
+ - Fast and flexible configuration files for Bash, Zsh, and more.
66
+ - Fully documented and translated into several languages (English,
67
+ French, and more).
68
+ - Supports Apple Silicon (M1) and Intel chips (x86_64).
69
+ - Uses Roboto Mono for Powerline font for enhanced terminal experience.
44
70
 
45
71
  ![divider][divider]
46
72
 
47
- ## 🚀 Getting Started
73
+ ## Getting Started 🚀
48
74
 
49
- We are so delighted that you have decided to try Dotfiles, and are sure that you
50
- will find Dotfiles unique and helpful.
75
+ We are so delighted that you have decided to try Dotfiles, and are sure
76
+ that you will find Dotfiles unique and helpful.
51
77
 
52
- Dotfiles seeks to bring you high quality and easy to use standalone and modular
53
- configuration files that can be used to customize your development environment
54
- across numerous computers and operating systems (macOS, Windows, Linux).
78
+ To get started, please follow the instructions below. If you have any
79
+ questions, please feel free to contact us.
55
80
 
56
- ### 🔧 Installation
81
+ ### Installation
57
82
 
58
- We understand that you may want to install Dotfiles without reading long manuals
59
- and lengthy documentation. In that respect, we have tried to make the
60
- installation process as easy as possible.
83
+ We understand that you may want to install Dotfiles without reading long
84
+ manuals and lengthy documentation. In that respect, we have tried to
85
+ make the installation process as easy and automated as possible.
61
86
 
62
- A range of installation methods are available, and we recommend that you choose
63
- the one that best suits your needs.
87
+ A range of installation methods are available, and we recommend that you
88
+ choose the one that best suits your needs.
64
89
 
65
- Before you begin your installation, use this information to ensure that you meet
66
- all the hardware, software, and system requirements for installing Dotfiles.
90
+ Before you begin your installation, use this information to ensure that
91
+ you meet all the hardware, software, and system requirements for
92
+ installing Dotfiles.
67
93
 
68
- #### 📋 System Requirements
94
+ #### 1) System Requirements
69
95
 
70
- You need a modern operating system to install Dotfiles. Here's an non-exhaustive
71
- list of the recommended operating systems that we support.
96
+ You need a modern operating system to install Dotfiles. Here's an non-
97
+ exhaustive list of the recommended operating systems that we support.
72
98
 
73
- If you don't see your operating system listed, it may still work, but we have
74
- yet been able to test it. If you have any issues, please let us know.
99
+ If you don't see your operating system listed, it may still work, but we
100
+ have yet been able to test it. If you have any issues, please let us
101
+ know.
75
102
 
76
103
  - macOS 10.15 or later
77
104
  - Windows 10 or later
78
- - A Debian based distribution ([Debian][debian-url], [Ubuntu][ubuntu-url],
79
- [PoP!_OS][pop-url], [Zorin OS][zorin-url], [Q4OS][q4-url],
80
- [Kali Linux][kali-url], [Devuan][devuan-url], [Deepin][deepin-url], etc.)
105
+ - A Debian based distribution ([Debian][08], [Ubuntu][27],
106
+ [PoP!_OS][22], [Zorin OS][29], [Q4OS][23], [Kali Linux][18],
107
+ [Devuan][10], [Deepin][09], etc.)
81
108
 
82
- ![divider][divider]
109
+ #### 2) Software Requirements
83
110
 
84
- #### ✔️ Software Requirements
111
+ The following programs must be installed on your system to install
112
+ Dotfiles:
85
113
 
86
- The following programs must be installed on your system to install Dotfiles:
87
-
88
- - [**Bash**][bash-url] - a shell, or command language interpreter, for the GNU
114
+ - [**Bash**][03] - a shell, or command language interpreter, for the GNU
89
115
  operating system.
90
- - Or [**Zsh**][zsh-url] - a shell designed for interactive use, although it is
91
- also a powerful scripting language.
92
- - [**Git**][git-url] - a free and open source distributed version control system
93
- designed to handle everything from small to very large projects with speed and
94
- efficiency.
95
- - [**Curl**][curl-url] - a command line tool for transferring data with URL
116
+ - Or [**Zsh**][30] - a shell designed for interactive use, although it
117
+ is also a powerful scripting language.
118
+ - [**Git**][15] - a free and open source distributed version control
119
+ system designed to handle everything from small to very large projects
120
+ with speed and efficiency.
121
+ - [**Curl**][07] - a command line tool for transferring data with URL
96
122
  syntax.
97
- - [**Wget**][wget-url] - a free software package for retrieving files using
123
+ - [**Wget**][28] - a free software package for retrieving files using
98
124
  HTTP, HTTPS and FTP, the most widely-used Internet protocols.
99
- - [**Make**][make-url] - a tool which controls the generation of executables and
100
- other non-source files of a program from the program's source files.
101
- - [**Shell**][shell-url] - a shell command line interpreter program for
102
- Unix-like operating systems.
103
- - [**PnPM**][pnpm-url] - a package manager for JavaScript and Node.js. It is
125
+ - [**Make**][19] - a tool which controls the generation of executables
126
+ and other non-source files of a program from the program's source
127
+ files.
128
+ - [**Shell**][26] - a shell command line interpreter program for Unix-
129
+ like operating systems.
130
+ - [**PnPM**][21] - a package manager for JavaScript and Node.js. It is
104
131
  fast, disk space efficient and reliable.
105
132
 
106
- #### Font
133
+ #### 3) Font Requirements
107
134
 
108
- We recommend using a font such as `Roboto Mono for Powerline` for terminal and
109
- vscode editor.
135
+ We recommend using a font such as `Roboto Mono for Powerline` for
136
+ terminal and vscode editor.
110
137
 
111
138
  On macOS, you can install the font using the following command:
112
139
 
@@ -124,26 +151,35 @@ On Linux, you can install the font using the following command:
124
151
  sudo apt install fonts-roboto-mono-for-powerline
125
152
  ```
126
153
 
154
+ ### Documentation
155
+
156
+ To read the documentation for Dotfiles, please visit:
157
+
158
+ - [Dotfiles website][00]
159
+ - [Dotfiles Docs GitHub repository][11]
160
+
161
+ ![divider][divider]
162
+
163
+ ## Usage 📖
164
+
127
165
  ### 1️⃣ Download Dotfiles
128
166
 
129
- You can download the latest version (v0.2.464) with the following options:
167
+ You can download the latest version (v0.2.466) with the following
168
+ options:
130
169
 
131
- - [**Manual download**][releases-url] - **The easiest way to install Dotfiles.**
132
- - [**Install with PnPM**][package-url]
133
- `pnpm i @sebastienrousseau/dotfiles`.
134
- - [**Install with Npm**][package-url]
135
- `npm install @sebastienrousseau/dotfiles`.
136
- - [**Install with Yarn**][package-url]
137
- `yarn add @sebastienrousseau/dotfiles`.
138
- - **Clone the main repository** to get all source files including build scripts:
139
- `git clone https://github.com/sebastienrousseau/dotfiles.git`. This will clone
140
- the latest version of the Dotfiles repository.
170
+ - [**Manual download**][24] - **The easiest way to install Dotfiles.**
171
+ - [**Install with PnPM**][20] `pnpm i @sebastienrousseau/dotfiles`.
172
+ - [**Install with Npm**][20] `npm install @sebastienrousseau/dotfiles`.
173
+ - [**Install with Yarn**][20] `yarn add @sebastienrousseau/dotfiles`.
174
+ - **Clone the main repository** to get all source files including build
175
+ scripts: `git clone https://github.com/sebastienrousseau/dotfiles.git`
176
+ . This will clone the latest version of the Dotfiles repository.
141
177
 
142
178
  ### 2️⃣ Back Up Your Existing Data
143
179
 
144
- Before installing Dotfiles, we strongly recommend that you back up your existing
145
- data. The Dotfiles installer will try to automatically backup any previous
146
- installation of known dotfiles into a backup directory
180
+ Before installing Dotfiles, we strongly recommend that you back up your
181
+ existing data. The Dotfiles installer will try to automatically backup
182
+ any previous installation of known dotfiles into a backup directory
147
183
  `$HOME/dotfiles_backup`.
148
184
 
149
185
  The backup files are the following:
@@ -175,22 +211,24 @@ The backup files are the following:
175
211
  cacert.pem
176
212
  ```
177
213
 
178
- It is always a good idea to backup as there might be situations in which you
179
- could be required to restore your previous installation.
214
+ It is always a good idea to backup as there might be situations in which
215
+ you could be required to restore your previous installation.
180
216
 
181
217
  ### 3️⃣ Try it out and let us know what you think
182
218
 
183
- To install the latest version of the dotfiles, run the following command:
219
+ To install the latest version of the dotfiles, run the following
220
+ command:
184
221
 
185
- #### Using make (easiest)
222
+ #### Using make (easiest and recommended)
186
223
 
187
- The easiest way to install Dotfiles is to use the `make` command. This will
188
- install the latest version of the dotfiles and will automatically backup
189
- any existing dotfiles you may have into a backup directory
224
+ The easiest way to install Dotfiles is to use the `make` command. This
225
+ will install the latest version of the dotfiles and will automatically
226
+ backup any existing dotfiles you may have into a backup directory
190
227
  `$HOME/dotfiles_backup`.
191
228
 
192
- The installer will check if you have PnPM installed to switch to the PnPM
193
- installation method. If not, it will fallback to equivalent shell scripts.
229
+ The installer will check if you have PnPM installed to switch to the
230
+ PnPM installation method. If not, it will fallback to equivalent shell
231
+ scripts.
194
232
 
195
233
  Switch to the `dist` directory and run:
196
234
 
@@ -198,7 +236,8 @@ Switch to the `dist` directory and run:
198
236
  make build
199
237
  ```
200
238
 
201
- You can also just check the installer options available, by simply running:
239
+ You can also just check the installer options available, by simply
240
+ running:
202
241
 
203
242
  ```bash
204
243
  make help
@@ -214,14 +253,14 @@ command in the `dist` directory located in your
214
253
  node .
215
254
  ```
216
255
 
217
- This will install the latest version of the dotfiles and will automatically
218
- backup any existing dotfiles you may have into a backup directory
219
- `$HOME/dotfiles_backup`.
256
+ This will install the latest version of the dotfiles and will
257
+ automatically backup any existing dotfiles you may have into a backup
258
+ directory `$HOME/dotfiles_backup`.
220
259
 
221
260
  #### Using PnPM (highly recommended if you have PnPM installed)
222
261
 
223
- PnPM is a key dependency of the dotfiles package. It will help you install the
224
- dotfiles rapidly and very efficiently.
262
+ PnPM is a key dependency of the dotfiles package. It will help you
263
+ install the dotfiles rapidly and very efficiently.
225
264
 
226
265
  Switch to the `dist` directory and run:
227
266
 
@@ -229,246 +268,52 @@ Switch to the `dist` directory and run:
229
268
  pnpm run build
230
269
  ```
231
270
 
232
- This will install the latest version of the dotfiles and will automatically
233
- backup any existing dotfiles you may have into a backup directory
234
- `$HOME/dotfiles_backup`.
271
+ This will install the latest version of the dotfiles and will
272
+ automatically backup any existing dotfiles you may have into a backup
273
+ directory `$HOME/dotfiles_backup`.
235
274
 
236
275
  ### Post installation
237
276
 
238
277
  Following the installation, you can verify that the dotfiles package is
239
278
  installed in the following directory `$HOME/dotfiles_backup`.
240
279
 
241
- Just quit your terminal and restart it. If the installation is successful, you
242
- should be able to see a new interface of your terminal and be able to start
243
- using the dotfiles aliases and other configurations.
280
+ Just quit your terminal and restart it. If the installation is
281
+ successful, you should be able to see a new interface of your terminal
282
+ and be able to start using the dotfiles aliases and other
283
+ configurations.
244
284
 
245
- Please refer to the [documentation][docs-url] for more information.
285
+ Please refer to the [documentation][11] for more information.
246
286
 
247
287
  ![divider][divider]
248
288
 
249
- ### 4️⃣ What's included
289
+ ## Releases 🔗
250
290
 
251
- Dotfiles contains core elements that are used to configure your shell, and
252
- other components catered for your environment setup.
253
-
254
- Within the download you'll find all the Dotfiles source files grouped within
255
- the `dist` folder.
256
-
257
- You'll see something like this:
258
-
259
- ```bash
260
- .
261
- ├── bin
262
- │   ├── backup.d.ts
263
- │   ├── backup.d.ts.map
264
- │   ├── backup.js
265
- │   ├── backup.js.map
266
- │   ├── constants.d.ts
267
- │   ├── constants.d.ts.map
268
- │   ├── constants.js
269
- │   ├── constants.js.map
270
- │   ├── copy.d.ts
271
- │   ├── copy.d.ts.map
272
- │   ├── copy.js
273
- │   ├── copy.js.map
274
- │   ├── dotfiles.d.ts
275
- │   ├── dotfiles.d.ts.map
276
- │   ├── dotfiles.js
277
- │   ├── dotfiles.js.map
278
- │   ├── download.d.ts
279
- │   ├── download.d.ts.map
280
- │   ├── download.js
281
- │   ├── download.js.map
282
- │   ├── index.d.ts
283
- │   ├── index.d.ts.map
284
- │   ├── index.js
285
- │   ├── index.js.map
286
- │   ├── transfer.d.ts
287
- │   ├── transfer.d.ts.map
288
- │   ├── transfer.js
289
- │   ├── transfer.js.map
290
- │   ├── unpack.d.ts
291
- │   ├── unpack.d.ts.map
292
- │   ├── unpack.js
293
- │   └── unpack.js.map
294
- ├── lib
295
- │   ├── aliases
296
- │   │   ├── default
297
- │   │   │   └── default.aliases.sh
298
- │   │   ├── gcloud
299
- │   │   │   └── gcloud.aliases.sh
300
- │   │   ├── git
301
- │   │   │   └── git.aliases.sh
302
- │   │   ├── heroku
303
- │   │   │   └── heroku.aliases.sh
304
- │   │   ├── jekyll
305
- │   │   │   └── jekyll.aliases.sh
306
- │   │   ├── pnpm
307
- │   │   │   └── pnpm.aliases.sh
308
- │   │   ├── subversion
309
- │   │   │   └── subversion.aliases.sh
310
- │   │   └── tmux
311
- │   │   └── tmux.aliases.sh
312
- │   ├── configurations
313
- │   │   ├── bash
314
- │   │   │   └── bashrc
315
- │   │   ├── curl
316
- │   │   │   ├── cacert.pem
317
- │   │   │   └── curlrc
318
- │   │   ├── default
319
- │   │   │   ├── color.sh
320
- │   │   │   ├── constants.sh
321
- │   │   │   ├── editor.sh
322
- │   │   │   └── prompt.sh
323
- │   │   ├── gem
324
- │   │   │   └── gemrc
325
- │   │   ├── input
326
- │   │   │   └── inputrc
327
- │   │   ├── jshint
328
- │   │   │   └── jshintrc
329
- │   │   ├── nano
330
- │   │   │   └── nanorc
331
- │   │   ├── profile
332
- │   │   │   └── profile
333
- │   │   ├── tmux
334
- │   │   │   ├── default
335
- │   │   │   ├── display
336
- │   │   │   ├── linux
337
- │   │   │   ├── navigation
338
- │   │   │   ├── panes
339
- │   │   │   ├── theme
340
- │   │   │   ├── tmux
341
- │   │   │   └── vi
342
- │   │   ├── vim
343
- │   │   │   └── vimrc
344
- │   │   ├── wget
345
- │   │   │   └── wgetrc
346
- │   │   ├── zsh
347
- │   │   │   └── zshrc
348
- │   │   └── README.md
349
- │   ├── functions
350
- │   │   ├── README.md
351
- │   │   ├── cdls.sh
352
- │   │   ├── changediskpwd.tmp
353
- │   │   ├── code.tmp
354
- │   │   ├── countdown.tmp
355
- │   │   ├── curlheader.sh
356
- │   │   ├── curltime.sh
357
- │   │   ├── encode64.sh
358
- │   │   ├── environment.sh
359
- │   │   ├── extract.sh
360
- │   │   ├── filehead.sh
361
- │   │   ├── genpwd.sh
362
- │   │   ├── goto.sh
363
- │   │   ├── headers.tmp
364
- │   │   ├── hidehiddenfiles.sh
365
- │   │   ├── history-all.tmp
366
- │   │   ├── hostinfo.sh
367
- │   │   ├── hstats.sh
368
- │   │   ├── httpdebug.sh
369
- │   │   ├── keygen.sh
370
- │   │   ├── last.sh
371
- │   │   ├── logout.sh
372
- │   │   ├── lowercase.sh
373
- │   │   ├── macos.sh
374
- │   │   ├── matrix.sh
375
- │   │   ├── mcd.sh
376
- │   │   ├── mount_read_only.sh
377
- │   │   ├── myproc.sh
378
- │   │   ├── prependpath.sh
379
- │   │   ├── print.tmp
380
- │   │   ├── ql.sh
381
- │   │   ├── rd.sh
382
- │   │   ├── remove_disk.sh
383
- │   │   ├── ren.sh
384
- │   │   ├── rm.tmp
385
- │   │   ├── rps.tmp
386
- │   │   ├── showhiddenfiles.sh
387
- │   │   ├── size.sh
388
- │   │   ├── stopwatch.sh
389
- │   │   ├── trash.tmp
390
- │   │   ├── tree.tmp
391
- │   │   ├── uppercase.sh
392
- │   │   ├── uuidgen.tmp
393
- │   │   ├── view-source.sh
394
- │   │   ├── vscode.sh
395
- │   │   ├── whoisport.sh
396
- │   │   └── zipf.sh
397
- │   ├── paths
398
- │   │   ├── ant
399
- │   │   │   └── ant.paths.sh
400
- │   │   ├── default
401
- │   │   │   └── default.paths.sh
402
- │   │   ├── homebrew
403
- │   │   │   └── homebrew.paths.sh
404
- │   │   ├── java
405
- │   │   │   └── java.paths.sh
406
- │   │   ├── maven
407
- │   │   │   └── maven.paths.sh
408
- │   │   ├── node
409
- │   │   │   └── node.paths.sh
410
- │   │   ├── nvm
411
- │   │   │   └── nvm.paths.sh
412
- │   │   ├── pnpm
413
- │   │   │   └── pnpm.paths.sh
414
- │   │   ├── python
415
- │   │   │   └── python.paths.sh
416
- │   │   ├── ruby
417
- │   │   │   └── ruby.paths.sh
418
- │   │   └── tmux
419
- │   │   └── tmux.paths.sh
420
- │   ├── README.md
421
- │   ├── aliases.sh
422
- │   ├── configurations.sh
423
- │   ├── exit.sh
424
- │   ├── functions.sh
425
- │   ├── history.sh
426
- │   └── paths.sh
427
- ├── scripts
428
- │   ├── backup.sh
429
- │   ├── banner.sh
430
- │   ├── build.sh
431
- │   ├── clean.sh
432
- │   ├── compile.sh
433
- │   ├── copy.sh
434
- │   ├── dotfiles.sh
435
- │   ├── download.sh
436
- │   ├── help.sh
437
- │   └── unpack.sh
438
- ├── Makefile
439
- └── filesizes.txt
440
-
441
- 38 directories, 141 files
442
-
443
- ```
444
-
445
- ## 🔗 Releases
446
-
447
- Releases are available on the [GitHub releases page][releases-url].
291
+ Releases are available on the [GitHub releases page][24].
448
292
 
449
293
  ![divider][divider]
450
294
 
451
- ## 🚥 Semantic versioning policy
295
+ ## Semantic versioning policy 🚥
452
296
 
453
- For transparency into our release cycle and in striving to maintain backward
454
- compatibility, `Dotfiles` follows [Semantic Versioning][semver-url].
297
+ For transparency into our release cycle and in striving to maintain
298
+ backward compatibility, `Dotfiles` follows
299
+ [Semantic Versioning][25].
455
300
 
456
301
  ![divider][divider]
457
302
 
458
303
  ## History
459
304
 
460
- - See [Dotfiles Release][releases-url] for a list of changes.
305
+ - See [Dotfiles Release][24] for a list of changes.
461
306
 
462
- ## ✅ Changelog
307
+ ## Changelog
463
308
 
464
- - [GitHub Releases][releases-url] are used for changelogs.
309
+ - [GitHub Releases][24] are used for changelogs.
465
310
 
466
311
  ![divider][divider]
467
312
 
468
313
  ## 📖 Code of Conduct
469
314
 
470
- We are committed to preserving and fostering a diverse, welcoming community.
471
- Please read our [Code of Conduct][code-of-conduct-url].
315
+ We are committed to preserving and fostering a diverse, welcoming
316
+ community. Please read our [Code of Conduct][04].
472
317
 
473
318
  ![divider][divider]
474
319
 
@@ -476,91 +321,74 @@ Please read our [Code of Conduct][code-of-conduct-url].
476
321
 
477
322
  - We believe perfection must consider everything.
478
323
  - We take our passion beyond code into our daily practices.
479
- - We are just obsessed about creating and delivering exceptional solutions.
324
+ - We are just obsessed about creating and delivering exceptional
325
+ solutions.
480
326
 
481
327
  ![divider][divider]
482
328
 
483
- ## ❤️ Contributing
329
+ ## Contribution 🤝
484
330
 
485
- Thank you for using Dotfiles! If you like the library, it would be
486
- great if you can give it a star ⭐ on [Github][github-url].
331
+ We welcome contributions to `Dotfiles`. Please see the
332
+ [contributing guidelines][05] for more information.
487
333
 
488
- There are also many ways in which you can participate in this project, for
489
- example:
490
-
491
- - [Submit bugs and feature requests][issues-url], and help us verify as they are
492
- checked in,
493
- - Review [source code changes][download-url], and help us improve our code quality,
494
- - Review the [documentation][docs-url] and make pull requests for anything from
495
- typos to additional and new content.
496
-
497
- Please read carefully through our
498
- [Contributing Guidelines][contributing-url]
499
- for further details on the process for submitting pull requests to us.
334
+ Unless you explicitly state otherwise, any contribution intentionally
335
+ submitted for inclusion in the work by you, as defined in the
336
+ Apache-2.0 license, shall be dual licensed as above, without any
337
+ additional terms or conditions.
500
338
 
501
339
  ![divider][divider]
502
340
 
503
- ## 🥂 License
341
+ ## License 📝
504
342
 
505
- This project is licensed under the [MIT License][license-url] file for details.
343
+ The project is licensed under the terms of both the MIT license and the
344
+ Apache License (Version 2.0).
506
345
 
507
- [![FOSSA Status][fossa]][fossa-url]
346
+ - [Apache License, Version 2.0][01]
347
+ - [MIT license][02]
508
348
 
509
349
  ![divider][divider]
510
350
 
511
- ## 🏢 Acknowledgements
512
-
513
- [Dotfiles][website-url] is beautifully crafted by these people and a bunch of
514
- awesome [contributors][contributors-url]
515
-
516
- | [![sr]][sr-url] | [![gr]][gr-url] |
517
- |:-----------------:|:------------------------------------:|
518
- | [Sebastien Rousseau][sr-url]| [Graham Colgate][gr-url] |
519
-
520
- [bash-url]: https://www.gnu.org/software/bash/
521
- [codacy-url]:https://www.codacy.com/gh/sebastienrousseau/dotfiles/dashboard
522
- [code-of-conduct-url]: https://github.com/sebastienrousseau/dotfiles/blob/master/.github/CODE-OF-CONDUCT.md
523
- [contributing-url]: https://github.com/sebastienrousseau/dotfiles/blob/master/.github/CONTRIBUTING.md
524
- [curl-url]: https://curl.se/
525
- [debian-url]: https://www.debian.org/
526
- [deepin-url]: https://www.deepin.org/en/
527
- [devuan-url]: https://devuan.org/
528
- [docs-url]: https://github.com/sebastienrousseau/dotfiles/docs
529
- [download-url]: https://github.com/sebastienrousseau/dotfiles/archive/refs/tags/v0.2.464.tar.gz
530
- [forks-url]: https://github.com/sebastienrousseau/dotfiles/network/members
531
- [fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2Freedia%2Fdotfiles?ref=badge_large
351
+ [00]: https://dotfiles.io
352
+ [01]: https://opensource.org/license/apache-2-0/ "Apache License, Version 2.0"
353
+ [02]: https://opensource.org/licenses/MIT "The MIT License"
354
+ [03]: https://www.gnu.org/software/bash/ "GNU Bash"
355
+ [04]: https://github.com/sebastienrousseau/dotfiles/blob/master/.github/CODE-OF-CONDUCT.md "Code of Conduct"
356
+ [05]: https://github.com/sebastienrousseau/dotfiles/blob/master/.github/CONTRIBUTING.md "Contributing Guidelines"
357
+ [06]:https://www.codacy.com/gh/sebastienrousseau/dotfiles/dashboard "Codacy"
358
+ [07]: https://curl.se/ "cURL"
359
+ [08]: https://www.debian.org/ "Debian"
360
+ [09]: https://www.deepin.org/en/ "Deepin"
361
+ [10]: https://devuan.org/ "Devuan"
362
+ [11]: https://github.com/sebastienrousseau/dotfiles/docs "Documentation"
363
+ [12]: https://github.com/sebastienrousseau/dotfiles/archive/refs/tags/v0.2.466.tar.gz "Download Dotfiles v0.2.466"
364
+ [13]: https://github.com/sebastienrousseau/dotfiles/network/members "List of members"
365
+ [14]: https://github.com/sebastienrousseau/dotfiles/graphs/contributors "List of contributors"
366
+ [15]: https://git-scm.com/ "Git"
367
+ [16]: https://github.com/sebastienrousseau/dotfiles "Dotfiles"
368
+ [17]: https://github.com/sebastienrousseau/dotfiles/issues "Issues"
369
+ [18]: https://www.kali.org/ "Kali Linux"
370
+ [19]: https://www.gnu.org/software/make/ "GNU Make"
371
+ [20]:https://www.npmjs.com/package/@sebastienrousseau/dotfiles "Dotfiles on NPM"
372
+ [21]: https://pnpm.io "PnPM"
373
+ [22]: https://pop.system76.com/ "Pop!_OS"
374
+ [23]: https://q4os.org/ "Q4OS"
375
+ [24]: https://github.com/sebastienrousseau/dotfiles/releases "Dotfiles Releases"
376
+ [25]: http://semver.org/ "Semantic Versioning"
377
+ [26]: https://www.gnu.org/software/shell/ "GNU Shell"
378
+ [27]: https://ubuntu.com/ "Ubuntu"
379
+ [28]: https://www.gnu.org/software/wget/ "GNU Wget"
380
+ [29]: https://zorinos.com/ "Zorin OS"
381
+ [30]: https://www.zsh.org/ "Zsh"
382
+
532
383
  [getting-started-url]: https://github.com/sebastienrousseau/dotfiles#getting-started
533
- [git-url]: https://git-scm.com/
534
- [github-url]: https://github.com/sebastienrousseau/dotfiles
535
- [gr-url]: https://github.com/gramtech
536
- [issues-url]: https://github.com/sebastienrousseau/dotfiles/issues
537
- [kali-url]: https://www.kali.org/
538
- [license-url]: https://opensource.org/licenses/MIT
539
- [make-url]: https://www.gnu.org/software/make/
540
- [package-url]:https://www.npmjs.com/package/@sebastienrousseau/dotfiles
541
- [pnpm-url]: https://pnpm.io
542
- [pop-url]: https://pop.system76.com/
543
- [q4-url]: https://q4os.org/
544
- [releases-url]: https://github.com/sebastienrousseau/dotfiles/releases
545
- [semver-url]: http://semver.org/
546
- [shell-url]: https://www.gnu.org/software/shell/
547
- [sr-url]: https://github.com/sebastienrousseau
548
- [ubuntu-url]: https://ubuntu.com/
549
- [website-url]: https://dotfiles.io
550
- [wget-url]: https://www.gnu.org/software/wget/
551
- [zorin-url]: https://zorinos.com/
552
- [zsh-url]: https://www.zsh.org/
553
384
 
385
+ [banner]: https://kura.pro/dotfiles/v2/images/titles/title-dotfiles.svg "Banner of Dotfiles"
554
386
  [codacy-grade]: https://img.shields.io/codacy/grade/634cfc4de08e492ebcbb341631066241?style=for-the-badge "Codacy grade"
555
387
  [contributors-shield]: https://img.shields.io/github/contributors/sebastienrousseau/dotfiles.svg?style=for-the-badge "Contributors"
556
- [contributors-url]: https://github.com/sebastienrousseau/dotfiles/graphs/contributors "List of contributors"
557
- [divider]: https://raw.githubusercontent.com/sebastienrousseau/dotfiles/master/assets/divider.svg "Divider"
558
- [download_button]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/button-secondary.svg "Download"
388
+
389
+ [divider]: https://kura.pro/assets/elements/divider.svg "Divider"
390
+ [download_button]: https://kura.pro/assets/buttons/button-secondary.svg "Download"
559
391
  [forks-shield]: https://img.shields.io/github/forks/sebastienrousseau/dotfiles.svg?style=for-the-badge "Forks"
560
- [fossa]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Freedia%2Fdotfiles.svg?type=large "FOSSA"
561
- [getting_started]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/button-primary.svg "Getting Started"
562
- [gr]: https://avatars0.githubusercontent.com/u/35816108?s=117 "Graham Colgate"
392
+ [getting_started]: https://kura.pro/assets/buttons/button-primary.svg "Getting Started"
563
393
  [license]: https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge\&color=ff69b4 "License"
564
- [logo]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/dotfiles.svg "Dotfiles"
565
- [love]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/made-with-love.svg "Made with Love"
566
- [sr]: https://avatars0.githubusercontent.com/u/1394998?s=117 "Sebastien Rousseau"
394
+ [love]: https://kura.pro/assets/shields/made-with-love.svg "Made with Love"