Skip to content

Commit 8bafdbd

Browse files
author
adrianbartyczak
committed
Add sections View content and Usage in aliases/README.md
1 parent 21cb39e commit 8bafdbd

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

aliases/README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,28 @@
33

44
This directory contains aliases. Aliases also constitute as frequently used short functions.
55

6-
## Notes
6+
## View content
7+
8+
To view all aliases, cd to the aliases directory and run the following:
9+
10+
```bash
11+
s='view-Shell-aliases.sh' && git show helper_scripts:"${s}" > /tmp/"${s}" && \
12+
chmod +x /tmp/"${s}" && /tmp/"${s}"
13+
```
714

8-
* Some aliases use environment variables *(e.g. ${EDITOR})* which must be defined or replaced if possible.
15+
## Usage
916

10-
* Aliases that work with files do not support file names with spaces.
17+
To source all the aliases files in your .bashrc, add the following:
18+
19+
```bash
20+
for f in $(find <path/to/Shell>/aliases -type f -name '*.aliases*'); do
21+
. "${f}"
22+
done
23+
```
24+
25+
## Notes
1126

27+
* Aliases do not support file names with spaces.
28+
* Some aliases use environment variables (e.g. ${EDITOR}) which must be defined if not already or replaced if possible.
1229
* Some aliases require a common dependency (e.g. gcc).
1330

0 commit comments

Comments
 (0)