Add documentation for Windows shells in config file (#1605)

* Add documentation for Windows in config file
Give real example for bash and PowerShell setup
This commit is contained in:
Jing Dong 2017-05-14 11:33:21 +01:00 committed by CHaBou
parent e57b8691f7
commit 8ef134d8d5

View file

@ -70,9 +70,16 @@ module.exports = {
// the shell to run when spawning a new session (i.e. /usr/local/bin/fish) // the shell to run when spawning a new session (i.e. /usr/local/bin/fish)
// if left empty, your system's login shell will be used by default // if left empty, your system's login shell will be used by default
// make sure to use a full path if the binary name doesn't work //
// (e.g `C:\\Windows\\System32\\bash.exe` instead of just `bash.exe`) // Windows
// if you're using powershell, make sure to remove the `--login` below // - Make sure to use a full path if the binary name doesn't work
// - Remove `--login` in shellArgs
//
// Bash on Windows
// - Example: `C:\\Windows\\System32\\bash.exe`
//
// Powershell on Windows
// - Example: `C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe`
shell: '', shell: '',
// for setting shell arguments (i.e. for using interactive shellArgs: ['-i']) // for setting shell arguments (i.e. for using interactive shellArgs: ['-i'])