Skip to content

Commit

Permalink
Update readme and github issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
Wramberg committed Aug 5, 2017
1 parent 3a96571 commit 8c48e89
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE.md
@@ -1,10 +1,11 @@
Please provide the following information when logging a bug:
Before submitting a bug please ensure you do not have a .bash_profile file or similar that changes the value of the TERM environment variable. This is set to "linux" by the plugin and must NOT be changed.

Please provide the following information when submitting a bug:

* OS used
* ST3 version
* Bash version
* Arguments being used with the terminal_view_open command
* If possible, a dump of the environment vars from the terminal view (call `env` in the terminal inside ST3)
* A dump of the environment vars from the terminal view (call `env` in the terminal inside ST3)
* Anything else you can think of that might help

and keep in mind that this plugin is maintained in my spare time so be patient.
9 changes: 8 additions & 1 deletion README.md
Expand Up @@ -7,9 +7,16 @@ A Linux/macOS plugin for Sublime Text 3 that allows for terminals inside editor
* Interactive applications (less, man, ipython, ssh, etc.)
* Auto-completion
* Terminal shortcuts (`ctrl`+`c`, etc.)
* Password prompts
* Basically everything you would expect from a terminal

Besides this it also supports

* Integration with the Sublime Text build system
* Shell colors (8 color support for now - development for 256 is planned)
* Scrollback history
* Copy/Pasting
* Static syntax highlighting (as an addition to shell colors)

**Note, if you encounter any issues please check the "Common problems" section at the bottom for a solution.**

![example.gif](https://raw.githubusercontent.com/Wramberg/TerminalView/master/example.gif "TerminalView Demonstration")
Expand Down

0 comments on commit 8c48e89

Please sign in to comment.