From e91db46ce023535ebad37c2158a723997cfbd16e Mon Sep 17 00:00:00 2001 From: Eric Freese Date: Sun, 7 Feb 2016 08:52:52 -0700 Subject: [PATCH] Add Development section to README (#106) --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dbb892c..08b0682 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,6 @@ bindkey '^ ' autosuggest-accept ## Compatibility With Other ZLE Plugins - ### [`zsh-syntax-highlighting`](https://github.com/zsh-users/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 This project is licensed under [MIT license](http://opensource.org/licenses/MIT).