mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-12 22:45:13 +00:00
Code Activity

add installation instructions for virtualenv

Browse Source
This commit is contained in:
deadc0de6
2018-09-01 17:56:42 +02:00
parent 33361ddea6
commit 1548a624d9
1 changed files with 48 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@@ -41,6 +41,7 @@ Quick start:
mkdir dotfiles && cd dotfiles mkdir dotfiles && cd dotfiles
git init git init
git submodule add https://github.com/deadc0de6/dotdrop.git git submodule add https://github.com/deadc0de6/dotdrop.git
sudo pip3 install -r dotdrop/requirements.txt
./dotdrop/bootstrap.sh ./dotdrop/bootstrap.sh
./dotdrop.sh --help ./dotdrop.sh --help
``` ```
@@ -90,6 +91,11 @@ to your dotfiles git tree or system-wide [with pypi](#with-pypi).
Having dotdrop as a submodule guarantees that anywhere your are cloning your dotfiles git tree Having dotdrop as a submodule guarantees that anywhere your are cloning your dotfiles git tree
from you'll have dotdrop shipped with it. It is the recommended way. from you'll have dotdrop shipped with it. It is the recommended way.
If you want to keep your python environment clean, it is recommended to use
the virtualenv installation instructions
(see [As a submodule in a virtualenv](as-a-submodule-in-a-virtualenv) and
[With pypi in a virtualenv](with-pypi-in-a-virtualenv)).
Dotdrop is also available on aur: Dotdrop is also available on aur:
* stable: https://aur.archlinux.org/packages/dotdrop/ * stable: https://aur.archlinux.org/packages/dotdrop/
* git version: https://aur.archlinux.org/packages/dotdrop-git/ * git version: https://aur.archlinux.org/packages/dotdrop-git/
@@ -107,11 +113,6 @@ $ ./dotdrop/bootstrap.sh
$ ./dotdrop.sh --help $ ./dotdrop.sh --help
``` ```
Install the requirements with:
```bash
$ sudo pip3 install -r dotdrop/requirements.txt
```
For MacOS users, make sure to install `realpath` through homebrew For MacOS users, make sure to install `realpath` through homebrew
(part of *coreutils*). (part of *coreutils*).
@@ -130,6 +131,30 @@ alias dotdrop=<absolute-path-to-dotdrop.sh>
Finally import your dotfiles as described [below](#usage). Finally import your dotfiles as described [below](#usage).
## As a submodule in a virtualenv
To install in a [virtualenv](https://virtualenv.pypa.io):
```bash
$ mkdir dotfiles; cd dotfiles
$ git init
$ git submodule add https://github.com/deadc0de6/dotdrop.git
$ virtualenv -p python3 env
$ echo 'env' » .gitignore
$ source env/bin/activate
$ pip install -r dotdrop/requirements.txt
$ ./dotdrop/bootstrap.sh
$ ./dotdrop.sh --help
```
When using a virtualenv, make sure to source the environment
before using dotdrop:
```bash
$ source env/bin/activate
$ ./dotdrop.sh --help
```
Then follow the instructions under [As a submodule](#as-a-submodule).
## With pypi ## With pypi
Start by installing dotdrop Start by installing dotdrop
@@ -154,6 +179,24 @@ by `dotdrop` if using the pypi solution.
Finally import your dotfiles as described [below](#usage). Finally import your dotfiles as described [below](#usage).
## With pypi in a virtualenv
Install dotdrop in a virtualenv from pypi
```bash
$ virtualenv -p python3 env
$ source env/bin/activate
$ pip install dotdrop
```
When using a virtualenv, make sure to source the environment
before using dotdrop:
```bash
$ source env/bin/activate
$ dotdrop --help
```
Then follow the instructions under [With pypi](#with-pypi).
# Usage # Usage
If starting fresh, the `import` command of dotdrop If starting fresh, the `import` command of dotdrop