Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 2.19 KB

README.md

File metadata and controls

38 lines (26 loc) · 2.19 KB

Overview

This is the CEF3-based application shell for Brackets.

Please read the main README in the brackets repo for general information about Brackets.

If you are interested in contributing to this shell, let us know on the brackets-dev Google Group, or on the #brackets channel on freenode.

If you run into any issues with this new shell, please file a bug in the brackets issue tracker.

Note: The brackets-shell is only maintained for use by the Brackets project. Although some people have definitely had success using it as an app shell for other projects, we don't provide any official support for that and we haven't done a ton of work to make the app shell easily reusable. Many people will likely find it easier to use a project like NW.js or electron, which is more generic by design.

Running

There are no downloads for the brackets-shell. You either need to build from source, or grab the latest Brackets installer and run the shell from that.

When the app is launched, it first looks for an index.html file in the following locations:

  • Mac - Brackets.app/Contents/dev/src/index.html, Brackets.app/Contents/www/index.html
  • Win - dev/src/index.html, www/index.html (these folders must be in the same folder as Brackets.exe)
  • Linux - dev/src/index.html, www/index.html (these folders must be in the same folder as the Brackets executable)

If the index.html can't be found, you'll be prompted to find the brackets index.html file. Make sure you select the brackets/src/index.html file, and not some other file.

The preferences are stored in {USER}/Library/Application Support/Brackets/cef_data on Mac, {USER}\AppData\Roaming\Brackets\cef_data on Windows, and ~/.Brackets/cef_data on Linux.

Building

Information on building the app shell can be found on the brackets-shell wiki.