diff options
| -rw-r--r-- | AUTHORS.md (renamed from AUTHORS.rst) | 0 | ||||
| -rw-r--r-- | HISTORY.md (renamed from HISTORY.rst) | 2 | ||||
| -rw-r--r-- | LICENSE.md (renamed from LICENSE.rst) | 0 | ||||
| -rw-r--r-- | MANIFEST.in | 2 | ||||
| -rw-r--r-- | README.md (renamed from README.rst) | 64 | ||||
| -rw-r--r-- | dotfiles/__init__.py | 2 | ||||
| -rw-r--r-- | setup.py | 7 |
7 files changed, 36 insertions, 41 deletions
@@ -6,7 +6,7 @@ History * Completely new git-like UI based on Click * Behaviour change to symlink files at any depth - - backwards incompatible, see README.rst + - backwards incompatible, see README.md * Lots of refactoring and cleanups * Several new tests to improve coverage diff --git a/MANIFEST.in b/MANIFEST.in index bb37a27..efa752e 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1 @@ -include *.rst +include *.md @@ -1,40 +1,36 @@ -Dotfile Management Made Easy -============================ +# Dotfile Management Made Easy -``dotfiles`` is a tool to make managing your dotfile symlinks in -``$HOME`` easy, allowing you to keep all your dotfiles in a single -directory. +`dotfiles` is a tool to make managing your dotfile symlinks in `$HOME` +easy, allowing you to keep all your dotfiles in a single directory. Hosting is up to you. You can use a VCS like git, Dropbox, or even rsync to distribute your dotfiles repository across multiple hosts. One or more repositories can be specified at runtime or with an environment variable, so you can manage multiple repositories without -hassle. See the Configuration_ section below for further details. +hassle. You can choose to have your dotfiles linked with symbolic links or -copied into place, either way ``dotfiles`` will keep track of what's +copied into place, either way `dotfiles` will keep track of what's missing and what's different. -``dotfiles`` is unique in the way it manages links and copies. The -entire directory structure leading to a file is preserved and only the -file itself is considered managed. This allows managed and unmanaged -files to live next to each other without needing to specify complicated -ignore rules. If you want to be less selective, you can specify a -directory that contains several files, and ``dotfiles`` will grab all of -them in whatever hierarchy they exist. +`dotfiles` is unique in the way it manages links and copies. The entire +directory structure leading to a file is preserved and only the file +itself is considered managed. This allows managed and unmanaged files +to live next to each other without needing to specify complicated ignore +rules. If you want to be less selective, you can specify a directory +that contains several files, and `dotfiles` will grab all of them in +whatever hierarchy they exist. -Upgrading From An Old Version ------------------------------ +## Upgrading From An Old Version Much has changed in the most recent version. If you're considering upgrading it's probably best to unlink everything and start with an empty repository. This can be done with the following command: - $ dotfiles --unsync + $ dotfiles --unsync -Installation ------------- +## Installation There are a few ways to install this thing. The easiest way is using whatever package manager is available on your OS if there is an official @@ -42,37 +38,35 @@ package available. If not, you can install globally with pip: - $ pip install dotfiles + $ pip install dotfiles If you don't want to or don't have permission to install it globally, you can install it just for your user: - $ pip install --user dotfiles + $ pip install --user dotfiles If you just want to run it directly from the source tree, you can do that too: - $ git clone https://github.com/jbernard/dotfiles - $ cd dotfiles - $ git submodule update --init - $ ./bin/dotfiles --help + $ git clone https://github.com/jbernard/dotfiles + $ cd dotfiles + $ git submodule update --init + $ ./bin/dotfiles --help Note: the source tree example above will run whatever code has been committed to your current checkout, whereas pip will fetch the latest official version from pypi. This might be what you want, but you should be aware. -Getting Help And Discovering Commands -------------------------------------- +## Getting Help And Discovering Commands -``dotfiles`` uses click for its CLI interface, so every subcommand -accepts the ``--help`` flag to offer additional information on what is -available. The aim is for this information to be sufficient for use. -At some point I'll write a manpage, but do file a bug if any of the -usage information is inaccurate or misleading. +`dotfiles` uses click for its CLI interface, so every subcommand accepts +the `--help` flag to offer additional information on what is available. +The aim is for this information to be sufficient for use. At some point +I'll write a manpage, but do file a bug if any of the usage information +is inaccurate or misleading. -A Quick Example ---------------- +## A Quick Example @@ -247,4 +241,4 @@ make sure tests pass, and send a pull request. Go ahead and add yourself to AUTHORS_ or I'll do it when I merge your changes. .. _`the repository`: https://github.com/jbernard/dotfiles -.. _AUTHORS: https://github.com/jbernard/dotfiles/blob/master/AUTHORS.rst +.. _AUTHORS: https://github.com/jbernard/dotfiles/blob/master/AUTHORS.md diff --git a/dotfiles/__init__.py b/dotfiles/__init__.py index 31d95b1..2f762b6 100644 --- a/dotfiles/__init__.py +++ b/dotfiles/__init__.py @@ -6,7 +6,7 @@ allowing you to keep all your configuration files in a single directory. :copyright: (c) 2011-2018 by Jon Bernard. - :license: ISC, see LICENSE.rst for more details. + :license: ISC, see LICENSE.md for more details. """ __version__ = '0.9.dev0' @@ -9,9 +9,10 @@ setup( author_email='jbernard@jbernard.io', description='Easily manage your dotfiles', url='https://github.com/jbernard/dotfiles', - long_description=(open('README.rst').read() + '\n\n' + - open('LICENSE.rst').read() + '\n\n' + - open('HISTORY.rst').read()), + long_description_content_type='text/markdown', + long_description=(open('README.md').read() + '\n\n' + + open('LICENSE.md').read() + '\n\n' + + open('HISTORY.md').read()), license='ISC', packages=['dotfiles'], setup_requires=[ |