commit 7494df2db1bbd8d1c48514dd682a886e7583d785
parent d958951cba2b8e29b003079c024d000dd14d5da9
Author: gearsix <gearsix@tuta.io>
Date: Sun, 25 Apr 2021 18:42:11 +0100
made v2.2.0 updates in README
Diffstat:
2 files changed, 18 insertions(+), 26 deletions(-)
diff --git a/README b/README
@@ -19,7 +19,7 @@ ARGUMENTS
COMMANDS
Multiple DOTFILE args can be passed to each command.
- install <DOTFILE>...
+ install <DOTFILE> ...
create a symlink from DOTFILE to it's install location. DOTFILE
should be the filepath of the dotfile to install.
@@ -30,7 +30,7 @@ COMMANDS
an install location and aliases to reference the dotfile by when
using dotfm.
- update <ALIAS> <LOCATION>
+ update <DOTFILE> <LOCATION>
update the location that a previously installed dotfile (with an
alias matching ALIAS) symlink points to (sets it to point to
LOCATION).
@@ -42,12 +42,12 @@ COMMANDS
Will only remove the file if the file has been installed by dotfm
(and can be found in DOTFM CSV FILE).
- edit <DOTFILE>...
+ edit <DOTFILE> ...
Open DOTFILE in $EDITOR or nano if $EDITOR is not present.
DOTFILE should be an alias of the dotfile to edit.
- list [<DOTFILE>...]
+ list [<DOTFILE> ...]
Print a table of the install locations and aliases for all
dotfiles. If one or more DOTFILE arguments are present, then only
dotfiles with matching aliases will be listed.
@@ -73,13 +73,10 @@ ENVIRONMENT
nano will be used.
HINTS
- I would recommend modifying the "KNOWN DOTFILES" array in src/ dotfm.py
- to suite your own needs.
-
- If you can think of more standard-dotfiles that you think
- should be present in "KNOWN DOTFILES" feel free to get in touch and
- contribute to the list.
+ I would recommend modifying the "KNOWN" array in src/ dotfm.py
+ to suite your own needs if i've missed any dotfiles you frequently use.
AUTHORS & CONTRIBUTORS
- gearsix <gearsix@tuta.io> = original author
- - marta dias - https://www.instagram.com/marta.dias.z/ = contributed the wonderful logo
+ - marta dias - https://www.instagram.com/marta.dias.z/ = the logo
+
diff --git a/src/dotfm.1 b/src/dotfm.1
@@ -1,6 +1,6 @@
-.\" txt2man -d "25 November 2020" -t dotfm -s 1 -v "dotfm README" -r "v2.1.0" -s 1 README
+.\" txt2man -d "$(date)" -t "dotfm" -s 1 -v "dotfm README" -r "v2.2.0" -s 1 README
.\" Text automatically generated by txt2man
-.TH dotfm 1 "25 November 2020" "v2.1.0" "dotfm README"
+.TH dotfm 1 "Sun 25 Apr 18:41:28 BST 2021" "v2.2.0" "dotfm README"
.SH NAME
\fBdotfm \fP- a simple script to manage dotfiles.
\fB
@@ -37,9 +37,8 @@ Display \fBdotfm\fP version
Tell \fBdotfm\fP to shutup (hide info logs)
.SH COMMANDS
Multiple DOTFILE args can be passed to each command.
-.TP
-.B
-install <DOTFILE>\.\.\.
+.PP
+install <DOTFILE> \.\.\.
create a symlink from DOTFILE to it's install location. DOTFILE
should be the filepath of the dotfile to install.
.RS
@@ -53,7 +52,7 @@ using \fBdotfm\fP.
.RE
.TP
.B
-update <ALIAS> <LOCATION>
+update <DOTFILE> <LOCATION>
update the location that a previously installed dotfile (with an
alias matching ALIAS) symlink points to (sets it to point to
LOCATION).
@@ -69,7 +68,7 @@ Will only remove the file if the file has been installed by \fBdotfm\fP
.RE
.TP
.B
-edit <DOTFILE>\.\.\.
+edit <DOTFILE> \.\.\.
Open DOTFILE in $EDITOR or nano if $EDITOR is not present.
.RS
.PP
@@ -77,7 +76,7 @@ DOTFILE should be an alias of the dotfile to edit.
.RE
.TP
.B
-list [<DOTFILE>\.\.\.]
+list [<DOTFILE> \.\.\.]
Print a table of the install locations and aliases for all
dotfiles. If one or more DOTFILE arguments are present, then only
dotfiles with matching aliases will be listed.
@@ -102,12 +101,8 @@ EDITOR
The text editor to edit dotfiles with. If not present,
nano will be used.
.SH HINTS
-I would recommend modifying the "KNOWN DOTFILES" array in src/ dotfm.py
-to suite your own needs.
-.PP
-If you can think of more standard-dotfiles that you think
-should be present in "KNOWN DOTFILES" feel free to get in touch and
-contribute to the list.
+I would recommend modifying the "KNOWN" array in src/ dotfm.py
+to suite your own needs if i've missed any dotfiles you frequently use.
.RE
.PP
AUTHORS & CONTRIBUTORS
@@ -115,4 +110,4 @@ AUTHORS & CONTRIBUTORS
.IP \(bu 3
gearsix <gearsix@tuta.io> = original author
.IP \(bu 3
-marta dias - https://www.instagram.com/marta.dias.z/ = contributed the wonderful logo
+marta dias - https://www.instagram.com/marta.dias.z/ = the logo