From 733f3716079babe4f779022c4d7f0ebb02bf67c1 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Mon, 20 Mar 2017 03:55:47 -0400 Subject: [PATCH] lang/{go,javascript}: add READMEs --- modules/lang/go/README.md | 18 ++++++++++++++++++ modules/lang/javascript/README.md | 16 ++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 modules/lang/go/README.md create mode 100644 modules/lang/javascript/README.md diff --git a/modules/lang/go/README.md b/modules/lang/go/README.md new file mode 100644 index 000000000..c2421206d --- /dev/null +++ b/modules/lang/go/README.md @@ -0,0 +1,18 @@ +# Go + +Go support, including auto-completion (gocode), eldoc support (go-eldoc), REPL +support (gore), refactoring commands (gorename), syntax-checking (flycheck), +auto-formatting (gofmt), and snippets (yasnippet). + +Snippets can be found in `private/hlissner/snippets/go-mode`. + +## External Dependencies + +Run `make bootstrap go` to install these. + ++ Go (`brew install go`, `pacman -S go`) ++ gocode `go get -u github.com/nsf/gocode` (completion) ++ gore `go get -u github.com/motemen/gore` (REPL) ++ guru `golang.org/x/tools/cmd/guru` (code navigation commands) ++ gorename `golang.org/x/tools/cmd/gorename` (refactoring commands) + diff --git a/modules/lang/javascript/README.md b/modules/lang/javascript/README.md new file mode 100644 index 000000000..9002dba68 --- /dev/null +++ b/modules/lang/javascript/README.md @@ -0,0 +1,16 @@ +# javascript + +Javascript support, including auto-completion (tern), REPL support +(nodejs-repl), refactoring commands (js2-refactor), and syntax checking +(flycheck). + +Includes coffescript and jsx support, as well as project minor modes for nodejs +projects (with a package.json) or launchbar 6 actions. + +## External Dependencies + +Run `make bootstrap js` to install these. + ++ NodeJS & NPM (`brew install node`, `pacman -S nodejs npm`) ++ tern: `npm -g install tern` (for completion) +