linux/zsh-autosuggestions
1
0
Fork 0
mirror of https://github.com/zsh-users/zsh-autosuggestions.git synced 2024-11-18 09:51:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add Development section to README (#106)

Browse source
This commit is contained in:
Eric Freese 2016-02-07 08:52:52 -07:00
parent 28836f15c5
commit e91db46ce0
1 changed files with 23 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -72,7 +72,6 @@ bindkey '^ ' autosuggest-accept
## Compatibility With Other ZLE Plugins ## Compatibility With Other ZLE Plugins
### [`zsh-syntax-highlighting`](https://github.com/zsh-users/zsh-syntax-highlighting) ### [`zsh-syntax-highlighting`](https://github.com/zsh-users/zsh-syntax-highlighting)
Source `zsh-autosuggestions.zsh` *before* `zsh-syntax-highlighting`. Source `zsh-autosuggestions.zsh` *before* `zsh-syntax-highlighting`.
@ -149,6 +148,29 @@ When reporting an issue, please include:
``` ```
## Development
### Build Process
Edit the source files in `src/`. Run `make` to build `dist/autosuggestions.zsh` from those source files.
### Pull Requests
Pull requests are welcome! If you send a pull request, please:
- Match the existing coding conventions.
- Include helpful comments to keep the barrier-to-entry low for people new to the project.
- Write tests that cover your code as much as possible.
### Testing
Testing is performed with [`shunit2`](https://github.com/kward/shunit2) (v2.1.6). Documentation can be found [here](http://shunit2.googlecode.com/svn/trunk/source/2.1/doc/shunit2.html).
The test script lives at `script/test.zsh`. To run the tests, run `make test`.
## License ## License
This project is licensed under [MIT license](http://opensource.org/licenses/MIT). This project is licensed under [MIT license](http://opensource.org/licenses/MIT).