mirror of
https://github.com/deadc0de6/dotdrop.git
synced 2026-02-12 22:10:15 +00:00
improve documentation
This commit is contained in:
43
README.md
43
README.md
@@ -362,6 +362,9 @@ be executed.
|
|||||||
If used as a submodule, update it with
|
If used as a submodule, update it with
|
||||||
```bash
|
```bash
|
||||||
$ git submodule foreach git pull origin master
|
$ git submodule foreach git pull origin master
|
||||||
|
$ git add dotdrop
|
||||||
|
$ git commit -m 'update dotdrop'
|
||||||
|
$ git push
|
||||||
```
|
```
|
||||||
|
|
||||||
Through pypi:
|
Through pypi:
|
||||||
@@ -579,6 +582,11 @@ $ cd <dotfiles-directory>
|
|||||||
## get latest version of the submodule
|
## get latest version of the submodule
|
||||||
$ git submodule foreach git pull origin master
|
$ git submodule foreach git pull origin master
|
||||||
|
|
||||||
|
## and update it upstream
|
||||||
|
$ git add dotdrop
|
||||||
|
$ git commit -m 'update dotdrop'
|
||||||
|
$ git push
|
||||||
|
|
||||||
## update the bash script wrapper
|
## update the bash script wrapper
|
||||||
$ ./dotdrop/bootstrap.sh
|
$ ./dotdrop/bootstrap.sh
|
||||||
```
|
```
|
||||||
@@ -587,13 +595,40 @@ Otherwise, simply install it from pypi as explained [above](#with-pypi)
|
|||||||
and get rid of the submodule:
|
and get rid of the submodule:
|
||||||
|
|
||||||
* move to the dotfiles directory where dotdrop is used as a submodule
|
* move to the dotfiles directory where dotdrop is used as a submodule
|
||||||
|
```bash
|
||||||
|
$ cd <dotfiles-repository>
|
||||||
|
```
|
||||||
* remove the entire `submodule "dotdrop"` section in `.gitmodules`
|
* remove the entire `submodule "dotdrop"` section in `.gitmodules`
|
||||||
* stage the change with `git add .gitmodules`
|
* stage the changes
|
||||||
|
```bash
|
||||||
|
$ git add .gitmodules
|
||||||
|
```
|
||||||
* remove the entire `submodule "dotdrop"` section in `.git/config`
|
* remove the entire `submodule "dotdrop"` section in `.git/config`
|
||||||
* remove the submodule with `git rm --cached dotdrop`
|
* remove the submodule
|
||||||
* remove the submodule from .git with `rm -rf .git/modules/dotdrop`
|
```bash
|
||||||
|
$ git rm --cached dotdrop
|
||||||
|
```
|
||||||
|
* remove the submodule from .git
|
||||||
|
```bash
|
||||||
|
$ rm -rf .git/modules/dotdrop
|
||||||
|
```
|
||||||
* commit the changes
|
* commit the changes
|
||||||
* delete any remaining files from the dotdrop submodule with `rm -rf dotdrop`
|
```bash
|
||||||
|
$ git commit -m 'removing dotdrop submodule'
|
||||||
|
```
|
||||||
|
* remove any remaining files from the dotdrop submodule
|
||||||
|
```bash
|
||||||
|
$ rm -rf dotdrop
|
||||||
|
```
|
||||||
|
* remove `dotdrop.sh`
|
||||||
|
```bash
|
||||||
|
$ git rm dotdrop.sh
|
||||||
|
$ git commit -m 'remove dotdrop.sh script'
|
||||||
|
```
|
||||||
|
* push upstream
|
||||||
|
```bash
|
||||||
|
$ git push
|
||||||
|
```
|
||||||
|
|
||||||
# Contribution
|
# Contribution
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ sub="dotdrop"
|
|||||||
# pivot
|
# pivot
|
||||||
cd "${cur}" || { echo "Folder \"${cur}\" doesn't exist, aborting." && exit; }
|
cd "${cur}" || { echo "Folder \"${cur}\" doesn't exist, aborting." && exit; }
|
||||||
# init/update the submodule
|
# init/update the submodule
|
||||||
git submodule foreach git pull origin master
|
git submodule update --init --recursive
|
||||||
# launch dotdrop
|
# launch dotdrop
|
||||||
PYTHONPATH=dotdrop python3 -m dotdrop.dotdrop --cfg="${cfg}" "${args[@]}"
|
PYTHONPATH=dotdrop python3 -m dotdrop.dotdrop --cfg="${cfg}" "${args[@]}"
|
||||||
# pivot back
|
# pivot back
|
||||||
|
|||||||
@@ -21,6 +21,9 @@ If you want to keep it as a submodule (recommended), simply do the following:
|
|||||||
|
|
||||||
First get the latest version of dotdrop:
|
First get the latest version of dotdrop:
|
||||||
$ git submodule foreach git pull origin master
|
$ git submodule foreach git pull origin master
|
||||||
|
$ git add dotdrop
|
||||||
|
$ git commit -m 'update dotdrop'
|
||||||
|
$ git push
|
||||||
And then re-run the bootstrap script to update \"dotdrop.sh\":
|
And then re-run the bootstrap script to update \"dotdrop.sh\":
|
||||||
$ ./dotdrop/bootstrap.sh
|
$ ./dotdrop/bootstrap.sh
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user