Anish Athalye
043373ea74
Standardize documentation for extended config
...
This patch adds parameter/explanation tables for the two other commands
that support extended configuration syntaxes, so now we have
identically-formatted tables for link, shell, and clean.
This change was prompted by
https://github.com/anishathalye/dotbot/issues/223 .
2020-06-19 20:31:43 -04:00
Anish Athalye
8f136ee73f
Remove confusing example
...
Without an explanation of what's going on here, this example is
unnecessarily confusing. It's a neat example, but probably not worth
explaining this in Dotbot's README.
See https://github.com/anishathalye/dotbot/issues/224 .
2020-06-19 20:02:03 -04:00
Anish Athalye
7ffaa65482
Add --only and --except command-line arguments
...
Internal to Dotbot, we use the name "skip" instead of "except", because
the latter is a keyword, and using a name like "except_" didn't seem as
nice.
2020-03-26 11:23:07 -04:00
Anish Athalye
ec8498ffb8
Merge branch 'ypid/add/link_real_path_option'
2020-01-03 16:46:19 -05:00
Robin Schneider
138fdbc8d7
Add 'canonicalize-path' option to link
...
Dotbot had a hardcoded behaviour that the BASEDIR was always passed to
os.path.realpath which "returns the canonical path of the specified
filename, eliminating any symbolic links encountered in the path".
This might not always be desirable so this commit makes it configurable.
The use case where `canonicalize-path` comes in handy is the following:
You want to provide dotfiles in the Filesystem Hierarchy Standard under
`/usr/local/share/ypid_dotfiles/`. Now you want to provide
`.config/dotfiles` as a default in `/etc/skel`. When you now
pre-configure `/etc/skel` by running dotbot in it set has HOME, dotfiles
will refer to `/usr/local/share/ypid_dotfiles/` and not
`/etc/skel/.config/dotfiles` which does not look nice.
This is related to but not the same as the `relative` parameter used
with link commands.
2020-01-03 22:35:13 +01:00
Anish Athalye
3fcc13d803
Update dates
2020-01-03 16:19:21 -05:00
Anish Athalye
e38e021ab3
Add option to clean recursively
2019-12-31 19:14:23 -05:00
Albert Puig
eabd84bce1
Add ignore-missing option to link
2019-12-31 14:25:53 -05:00
Anish Athalye
a8380f6496
Migrate to travis-ci.com
2019-12-28 10:44:24 -05:00
Anish Athalye
8667b75a73
Add example of conditional link
2019-11-14 16:30:47 -05:00
Anish Athalye
7f97a6c6d0
Make list more compact
2019-11-12 15:01:03 -05:00
Jesse Leite
daf3a7c483
Add table of contents and organize headings a bit
2019-11-12 13:44:28 -05:00
Jesse Leite
5a0f6676d4
Add 'create' directive to create directories
2019-10-12 11:55:09 -04:00
Darshan Patel
d6975dc660
Add instructions to ignore dirty commits
2019-09-17 08:34:58 -04:00
ronalabraham
c97472bc27
Fix path
parameter's docs for linking feature
2019-06-04 14:42:21 -04:00
Anish Athalye
b062aeaf15
Simplify README
...
This patch removes JSON examples from the README.
2019-02-06 09:30:49 -05:00
Anish Athalye
cd04d886fe
Update dates
2019-01-09 20:46:21 -05:00
Anish Athalye
5e2d40939e
Merge branch 'thtliife/suppress-shell-cmd'
2018-11-21 19:50:46 -05:00
Vito Giarrusso
3bda18ed9c
Add quiet option to shell plugin
2018-11-21 19:50:32 -05:00
Ben Klein
a9cf9fffe4
Implement conditional linking
2018-10-16 20:22:40 -04:00
Anish Athalye
30caaf2780
Add PyPI package
...
This patch also makes the '-d' argument optional, with the base
directory defaulting to the directory of the configuration file.
2018-05-30 10:23:53 -04:00
Anish Athalye
8afca63f65
Update dates
2018-05-30 09:37:36 -04:00
Anish Athalye
7d069b4ac8
Rename 'use_glob' to 'glob'
2018-04-13 08:49:02 -04:00
Ben Klein
7ebb601a10
Add use_globs to readme
2018-04-13 08:49:02 -04:00
Mikołaj Biel
87cc8d890a
Fix shell example in README (add description)
2017-07-12 19:39:36 +02:00
August Valera
e2948b1a34
Fix README link to list of users after wiki reorg
...
wiki:List-of-Dotbot-Users -> wiki:Users
2017-04-19 10:59:30 -07:00
Anish Athalye
096035dd98
Add note
2017-04-19 08:46:45 -04:00
Anish Athalye
c29ba8d722
Add documentation on force option for clean plugin
2017-03-26 11:50:57 -04:00
Anish Athalye
ef558f85d9
Update dates
2017-03-06 15:20:35 -05:00
Anish Athalye
847cb101d4
Merge branch 'casey/empty-source'
2016-11-23 14:13:00 -05:00
Casey Rodarmor
d2e20c77db
Allow empty link sources
...
If the source for a link is null, use the basename of the destination
with a single leading '.' removed, if present.
2016-11-23 14:11:45 -05:00
Casey Rodarmor
54346fa942
Mention in readme that ~ is null in YAML
...
This is a weird YAML gotcha, and it seems worth mentioning in the readme
since Dotbot users are likely to run into it.
2016-11-18 23:27:54 -06:00
Anish Athalye
f04b94d4ae
Add info about initializing repo during setup
...
This change was suggested by Brian Jacobowski
<bjacobowski.dev@gmail.com>.
2016-08-15 17:44:30 -07:00
Anish Athalye
0618bc70cc
Change inspiration link to point to wiki
2016-04-10 02:17:21 -04:00
Anish Athalye
3d9b3ae2a8
Fix link
2016-03-26 09:16:41 -04:00
Anish Athalye
1374416362
Add link to wiki
2016-03-20 08:34:29 -04:00
Anish Athalye
f52bbd1eec
Add default options
...
This feature was implemented with feedback from Aleks Kamko
<aykamko@gmail.com> and Casey Rodarmor <casey@rodarmor.com>.
2016-03-03 09:42:50 -05:00
Anish Athalye
daf8d82e02
Add functionality to create relative links
...
This commit adds an option to the extended configuration syntax for
linking files and directories. Enabling the relative option makes it so
that symbolic links are created with relative paths instead of absolute
paths.
2016-02-14 23:06:52 -05:00
Anish Athalye
c402396c58
Add documentation and tests for plugins
2016-02-06 15:23:39 -05:00
Anish Athalye
ba9e9cbe70
Update dates
2016-01-31 08:03:06 -05:00
Benjamin Chrétien
07a26a843e
Add Travis CI support
...
The test suite has been slightly modified to allow running tests without
Vagrant on Travis.
2016-01-16 17:34:52 +09:00
Anish Athalye
c48d16cbce
Use standard library JSON parser for JSON files
...
This patch reverts the changes to the README made in
57265f78b4
and makes it so that Dotbot
supports JSON files with tab characters.
2016-01-13 11:29:12 -05:00
Anish Athalye
9250bef422
Add hook showing usage to README
2016-01-11 14:02:16 -05:00
Anish Athalye
57265f78b4
Add note to README about JSON parsing
...
Casey Rodarmor <casey@rodarmor.com> pointed out that Dotbot parses JSON
files as YAML. The YAML format doesn't allow tab characters, which are
normally allowed in JSON. This patch adds a note about this to the
README.
2016-01-11 13:36:16 -05:00
Anish Athalye
30dc7d5788
Fix typo
2015-10-19 10:13:23 -04:00
Anish Athalye
dcc3a1947a
Add link to init-dotfiles repository to README
2015-06-11 21:38:52 -07:00
The Aviator
01c022154e
Fix typos in README
2015-06-08 08:29:58 -07:00
Anish Athalye
c2036b7960
Restore information to README
...
The information that was added in
115210ab17
was removed in
4ed3ffc411
when reorganizing the README.
This commit restores the information.
2015-06-02 22:46:39 -07:00
Anish Athalye
9c1af76e9e
Add Mercurial install script
2015-05-22 13:33:10 -04:00
Anish Athalye
fd7f3b8551
Add environment variable expansion in link paths
...
This feature was proposed by Brian Knobbs <brian@redlattice.com>.
2015-05-12 20:28:58 -04:00