| 1 | Welcome to Brackets!
|
| 2 | -------------------
|
| 3 |
|
| 4 | This is a very early version of Brackets, a code editor for HTML, CSS
|
| 5 | and JavaScript that's *built* in HTML, CSS and JavaScript.
|
| 6 |
|
| 7 | What makes Brackets different from other web code editors?
|
| 8 | * **Tools shouldn't get in your way.** Instead of cluttering up your coding
|
| 9 | environment with lots of panels and icons, the Quick Edit UI in Brackets puts
|
| 10 | context-specific code and tools inline.
|
| 11 | * **Brackets is in sync with your browser.** With Live Development, Brackets
|
| 12 | works directly with your browser to push code edits instantly, set breakpoints,
|
| 13 | and jump back and forth between your real source code and the browser view.
|
| 14 | * **Do it yourself.** Because Brackets is open source, and built with HTML, CSS
|
| 15 | and JavaScript, you can help build the best code editor for the web.
|
| 16 |
|
| 17 | You can see some
|
| 18 | [screenshots of Brackets](https://github.com/adobe/brackets/wiki/Brackets-Screenshots)
|
| 19 | on the wiki.
|
| 20 |
|
| 21 | Brackets is *very* early in development, so many of the features you would
|
| 22 | expect in a code editor are missing, and some existing features might be
|
| 23 | incomplete or not as useful as you'd want. But if you like the direction
|
| 24 | it's going, please contribute!
|
| 25 |
|
| 26 | The text editor inside Brackets is based on
|
| 27 | [CodeMirror](http://github.com/marijnh/CodeMirror)—thanks to Marijn for
|
| 28 | taking our pull requests :) See
|
| 29 | [Notes on CodeMirror](https://github.com/adobe/brackets/wiki/Notes-on-CodeMirror)
|
| 30 | for info on upcoming things we're planning to contribute to CodeMirror.
|
| 31 |
|
| 32 | How to run Brackets
|
| 33 | -------------------
|
| 34 |
|
| 35 | **Brackets isn't ready for general use yet.** It's still *very* early in
|
| 36 | development, is missing a lot of basic editor features, and *probably*
|
| 37 | has bugs. That said, we've actually been using Brackets to develop Brackets
|
| 38 | for awhile now, so what's there is reasonably stable.
|
| 39 |
|
| 40 | Although Brackets is built in HTML/CSS/JS, it currently runs as a desktop
|
| 41 | application in a thin native shell, so that it can access your local files.
|
| 42 | (If you just try to open the index.html file in a browser, it won't work yet.)
|
| 43 | The native shell for Brackets lives in a separate repo,
|
| 44 | [adobe/brackets-shell](https://github.com/adobe/brackets-shell/).
|
| 45 |
|
| 46 | The Brackets native shell currently runs on Mac and Windows. Since it's based on
|
| 47 | CEF/Chromium, it could be ported to Linux relatively easily, but that work hasn't
|
| 48 | been done yet. Stay tuned.
|
| 49 |
|
| 50 | You can download "stable" builds of Brackets from the **Download Packages** section of the
|
| 51 | [downloads page](http://github.com/adobe/brackets/downloads)--make sure you download one
|
| 52 | of the .dmg/.msi installers in that section (the "Download as zip/tar.gz" buttons at the
|
| 53 | top will **not** work). If you want to pull the repo directly via git, see [How to Hack on Brackets](https://github.com/adobe/brackets/wiki/How-to-Hack-on-Brackets)
|
| 54 | for instructions on how to get everything.
|
| 55 |
|
| 56 | By default, Brackets opens a folder containing some simple "Getting Started" content.
|
| 57 | You can choose a different folder to edit from *File > Open Folder*. (Might we
|
| 58 | suggest editing the Brackets source code and submitting some pull requests?)
|
| 59 |
|
| 60 | Most of Brackets should be pretty self-explanatory, but for information on how
|
| 61 | to use its unique features, like Quick Edit and Live Development, please read
|
| 62 | [How to Use Brackets](http://github.com/adobe/brackets/wiki/How-to-Use-Brackets).
|
| 63 | The [extensions wiki page](https://github.com/adobe/brackets/wiki/Brackets-Extensions)
|
| 64 | has a list of extensions that have been contributed.
|
| 65 | Also, see the [release notes](http://github.com/adobe/brackets/wiki/Release-Notes)
|
| 66 | for a list of new features and known issues in each build.
|
| 67 |
|
| 68 | I found a bug/missing feature!
|
| 69 | ------------------------------
|
| 70 |
|
| 71 | Issues starting Brackets the first time? Please review [Troubleshooting](https://github.com/adobe/brackets/wiki/Troubleshooting).
|
| 72 |
|
| 73 | Brackets bugs are tracked in [the Brackets github issue tracker](https://github.com/adobe/brackets/issues).
|
| 74 | When filing a new bug, please remember to include:
|
| 75 |
|
| 76 | * Brackets version/sprint number (or commit SHA if you're pulling directly from the repo)
|
| 77 | * platform/OS version
|
| 78 | * repro steps, actual and expected results
|
| 79 | * link to test files (you can create a gist on [gist.github.com](https://gist.github.com/)
|
| 80 | if that's convenient)
|
| 81 |
|
| 82 | More details on how to file an issue can be found [here](https://github.com/adobe/brackets/wiki/How-to-Report-an-Issue).
|
| 83 | For feature requests, go ahead and file them in the issue tracker; they'll be converted
|
| 84 | to user stories on the [public Brackets backlog*](http://bit.ly/BracketsBacklog).
|
| 85 |
|
| 86 | \* Please excuse the mess in the "Icebox (To Be Reviewed)" list. We're still importing data from our internal system.
|
| 87 |
|
| 88 | I want to help!
|
| 89 | ---------------
|
| 90 |
|
| 91 | Awesome! Please read [How to Hack on Brackets](https://github.com/adobe/brackets/wiki/How-to-Hack-on-Brackets).
|
| 92 |
|
| 93 | I want to keep track of how Brackets is doing!
|
| 94 | ----------------------------------------------
|
| 95 |
|
| 96 | Not sure you needed the exclamation point there, but I like your enthusiasm.
|
| 97 |
|
| 98 | * **Twitter:** [@brackets](http://twitter.com/#!/brackets)
|
| 99 | * **IRC:** [#brackets on freenode](http://webchat.freenode.net/?channels=brackets)
|
| 100 | * **Developers mailing list:** http://groups.google.com/group/brackets-dev
|