arti/zsh-autoenv
1
0
Fork 0
mirror of https://github.com/Tarrasch/zsh-autoenv.git synced 2024-11-22 15:30:59 +02:00
Code Releases Activity

Cleanup README (#70)

Browse Source 
Fix issues reported by mdl and remove the unnecessary bitdeli badge.
This commit is contained in:
Daniel Hahler 2017-10-18 00:29:43 +02:00 committed by GitHub
parent c3afdc151f
commit 3258f584ec
1 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,5 +1,3 @@
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/Tarrasch/zsh-autoenv/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
[![Build Status](https://travis-ci.org/Tarrasch/zsh-autoenv.svg?branch=master)](https://travis-ci.org/Tarrasch/zsh-autoenv) [![Build Status](https://travis-ci.org/Tarrasch/zsh-autoenv.svg?branch=master)](https://travis-ci.org/Tarrasch/zsh-autoenv)
# Autoenv for Zsh # Autoenv for Zsh
@ -12,14 +10,14 @@ variables (overwriting and restoring).
## Features ## Features
- Support for enter and leave events, which can use the same file. - Support for enter and leave events, which can use the same file.
By default `.autoenv.zsh` is used for entering, and `.autoenv_leave.zsh` By default it uses `.autoenv.zsh` for entering, and `.autoenv_leave.zsh`
for leaving. for leaving.
- Interactively asks for confirmation / authentication before sourcing an - Interactively asks for confirmation / authentication before sourcing an
unknown `.autoenv.zsh` file, and remembers whitelisted files by their unknown `.autoenv.zsh` file, and remembers whitelisted files by their
hashed content. hashed content.
- Test suite. - Test suite.
- Written in Zsh. - Written in Zsh.
### Variable stashing ### Variable stashing
@ -52,7 +50,6 @@ have more control.
The varstash library has been taken from smartcd, and was optimized for Zsh. The varstash library has been taken from smartcd, and was optimized for Zsh.
## Writing your .autoenv.zsh file ## Writing your .autoenv.zsh file
### `autoenv_source_parent()` ### `autoenv_source_parent()`
@ -96,35 +93,41 @@ Add the following to your `.zshrc` where you are loading your plugins:
You can use the following variables to control zsh-autoenv's behavior. You can use the following variables to control zsh-autoenv's behavior.
Add them to your `~/.zshrc` file, before sourcing/loading zsh-autoenv. Add them to your `~/.zshrc` file, before sourcing/loading zsh-autoenv.
### AUTOENV\_FILE\_ENTER ### AUTOENV_FILE_ENTER
Name of the file to look for when entering directories. Name of the file to look for when entering directories.
Default: `.autoenv.zsh` Default: `.autoenv.zsh`
### AUTOENV\_FILE\_LEAVE ### AUTOENV_FILE_LEAVE
Name of the file to look for when leaving directories. Name of the file to look for when leaving directories.
Requires `AUTOENV_HANDLE_LEAVE=1`. Requires `AUTOENV_HANDLE_LEAVE=1`.
Default: `.autoenv_leave.zsh` Default: `.autoenv_leave.zsh`
### AUTOENV\_LOOK\_UPWARDS ### AUTOENV_LOOK_UPWARDS
Look for zsh-autoenv "enter" files in parent dirs? Look for zsh-autoenv "enter" files in parent dirs?
Default: `1` Default: `1`
### AUTOENV\_HANDLE\_LEAVE ### AUTOENV_HANDLE_LEAVE
Handle leave events when changing away from a subtree, where an "enter" Handle leave events when changing away from a subtree, where an "enter"
event was handled? event was handled?
Default: `1` Default: `1`
### AUTOENV\_DISABLED ### AUTOENV\_DISABLED
(Temporarily) disable zsh-autoenv. This gets looked at in the chpwd handler. (Temporarily) disable zsh-autoenv. This gets looked at in the chpwd handler.
Default: 0 Default: 0
### AUTOENV\_DEBUG ### AUTOENV\_DEBUG
Enable debugging. Multiple levels are supported (max 2).
Set debug level. If enabled (> 0) it will print information to stderr.
- 0: no debug messages - 0: no debug messages
- 1: generic debug logging - 1: generic debug logging
@ -193,10 +196,10 @@ fi
``` ```
## Related projects ## Related projects
- https://github.com/direnv/direnv
- https://github.com/cxreg/smartcd
- https://github.com/kennethreitz/autoenv
- <https://github.com/direnv/direnv>
- <https://github.com/cxreg/smartcd>
- <https://github.com/kennethreitz/autoenv>
## History ## History
@ -208,7 +211,7 @@ The code was initially based on
[@joshuaclayton](https://github.com/joshuaclayton)'s dotfiles. [@joshuaclayton](https://github.com/joshuaclayton)'s dotfiles.
In September 2013 [@Tarrasch](https://github.com/Tarrasch) packaged it into a In September 2013 [@Tarrasch](https://github.com/Tarrasch) packaged it into a
nice [antigen]-compatible unit with integration tests. Since November 2014, nice [antigen]-compatible unit with integration tests. Since November 2014,
[@blueyed](https://github.com/blueyed) took over and added many many nice [@blueyed](https://github.com/blueyed) took over and added many nice
features, mainly inspired by [smartcd]. features, mainly inspired by [smartcd].
[antigen]: https://github.com/Tarrasch/antigen-hs [antigen]: https://github.com/Tarrasch/antigen-hs