Building brackets shell

This project requires a CEF3 binary distribution in order to build.

Mac

####Prerequisites

• Xcode 4 required to build the project
  • In newer versions of Xcode, you might also need to install the "Command Line Tools" in Xcode from Preferences > Downloads.
• CEF3 binary distribution version 3.1180.719 or newer
• To modify the project files, you will also need:
  • python
  • chromium source code (at least the src/build and src/tools directories). Hopefully this is a short-term requirement.

####Setup and Building Create a folder named deps inside the brackets-shell folder. Create a folder named cef inside the deps folder. Copy all of the contents of the CEF3 binary distribution into the deps/cef directory.

Your directory structure should look like this:

brackets-shell
   deps
      cef
         // CEF3 binary content in this folder
   appshell
      // appshell source
   README.md
   ...

Open a terminal window on the brackets-shell directory and run scripts/make_symlinks.sh. This will create symbolic links to several folders in the deps/cef directory. Open appshell.pbxproj in XCode. NOTE: If you are using XCode 4.4, you will get a couple warnings. These are harmless, and will be fixed soon.

####Running When you launch Brackets, you will be prompted to select an index.html file. Navigate to your local copy of the brackets repo and select src/index.html. You will be prompted to select the index.html file every time you launch.

You can also run the tools/setup_for_hacking script in the brackets repo to create a symlink in your Brackets.app. Pass the full path to the app you are building. Debug builds are in the xcodebuild/Debug directory, and Release builds are in the xcodebuild/Release directory.

####Generating Projects This is only required if you are changing the project files. NOTE: Don't change the xcode project files directly. Any changes should be done to the .gyp files, and new xcode projects should be generated.

• Add a CHROMIUM_SRC_PATH environment variable that points to your chromium 'src' folder (without a final '/').
• Open a terminal window on this directory and run scripts/make_appshell_project.sh (Note: while not required, it is a good idea to delete the old appshell.xcodeproj before generating a new one.)

Windows

####Prerequisites

• Visual Studio 2010 or later required to build the project. The free Visual Studio Express works fine.
• CEF3 binary distribution version 3.1180.719 or newer
• To modify the project files, you will also need:
  • python
  • chromium source code (at least the src/build and src/tools directories). Hopefully this is a short-term requirement.

####Setup and Building Create a folder named deps inside the brackets-shell folder. Create a folder named cef inside the deps folder. Copy all of the contents of the CEF3 binary distribution into the deps/cef directory.

Your directory structure should look like this:

brackets-shell
   deps
      cef
         // CEF3 binary content in this folder
   appshell
      // appshell source
   README.md
   ...

Open a command prompt on the brackets-shell directory and run scripts\\make_symlinks.bat. This will create symbolic links to several folders in the deps/cef directory.

Open appshell.sln in Visual Studio. NOTE: If you are using Visual Studio Express, you may get warnings that say some of the projects couldn't be loaded. These can be ignored.

####Running When you launch Brackets, you will be prompted to select an index.html file. Navigate to your local copy of the brackets repo and select src\index.html. You will be prompted to select the index.html file every time you launch.

You can also run the tools\setup_for_hacking script in the brackets repo to create a symlink build directory. Pass the full path to the directory of the app you are building. Debug builds are in the Debug directory, and Release builds are in the Release directory.

####Generating Projects This is only required if you are changing the project files. NOTE: Don't change the Visual Studio project files directly. Any changes should be done to the .gyp files, and new Visual Studio projects should be generated.

• Add a CHROMIUM_SRC_PATH environment variable that points to your chromium 'src' folder (without a final '/').
• Open a command prompt on this directory and run scripts\make_appshell_project.bat

Linux

Not available yet. Please let us know if you'd like to help with the Linux version.