Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed markdown #46

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed markdown #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Brackets Terminal
=================

#MAINTEINER NEEDED
## MAINTEINER NEEDED
I no longer use brackets as my day-to-day editor and I'm not able to maintain this plugin anymore. I'll be happy to grant access to someone interest in doing so though - if you'd like to help, open an issue :)


Expand All @@ -14,34 +14,34 @@ You can also run another editor inside brackets!
![Nano](images/screenshot2.png)


##Installation
## Installation

* Brackets-terminal requires a [`tty.js`](https://github.com/chjj/tty.js/) server under the hood: run `$ npm install -g tty.js`
* Open a terminal and start the server with `$ tty.js`
* **Bonus**: you may want to add tty.js as a startup process in order to always have it running (see their website for more on configuration)
* Open Brackets > Extension Manager > Available and look for 'Brackets Terminal'. Hit `Install`
* Note that `tty.js` runs on port `8080` by default. You can specify a different port by running it with `tty.js --port <another_number>` and then set the same port in View > Bracket terminal settings

##Usage
## Usage

You will see a new button on the sidebar as well as a new command in the menu (`View > Show Terminal`) - and a `Cmd/Ctrl+shift+P` keyboard shortcut. If everything goes well,
the button in the sidebar will turn green and a terminal will show up as a bottom panel.
Starting from version 0.3, brackets terminal support multiple tab, too!



##Requirement
## Requirements

* \*nix environment (may work with Cygwin or similar, but not tested)
* `node.js` and `npm` installed


##Troubleshooting
## Troubleshooting

If, for some reason, your button turn yellow try to hit it back, it should go back to gray and another hit should open the terminal again.
If, at startup, the button is light-gray or it becomes red - it's because the tty.js server is no longer running.

##Contribution
## Contribution

Please, report any issue on the github repository, pull requests are welcome too.