Note: This README file is specific to the HTML/CSS/JS source code for Brackets. For more general notes on how to use the current build of Brackets, see the README.md file in the parent folder (or, if you're on github, the brackets-app repo).
This repository is for the core Brackets editor, written in HTML/CSS/JS. The desktop application shell, which adds native menu and local file access functionality, lives in a separate repo.
In addition to pulling the source from github, you'll need to also grab submodules referenced by Brackets. To do so, first make sure you have SSH access to github (since the submodule is referenced via a git: URL rather than https). Then run the following command in the root of your Brackets repo:
git submodule update --init --recursive
See Pro Git section 6.6 for some caveats when working with submodules.
To test if everything's working, load index.html into Safari (Chrome won't work, see below). You should see a message with a blue background, and an editor area below that with a line of code in it.
- Loading index.html directly into Chrome from the local filesystem will not work (the LESS processing will fail) due to Chrome security restrictions. You can run it within the shell app, or load it into a different browser, like Safari.
We track bugs at github.com. When filing a new bug, please remember to include:
- Brackets version/sprint number (or commit SHA if you're pulling directly from the repo)
- platform/OS version
- repro steps, actual and expected results
- link to test files (you can create a gist on gist.github.com if that's convenient).
For bugs that are really feature requests, go ahead and file them in the issue tracker; we'll convert them to user stories on our public backlog.