electron/brightray/README.md
Adam Roben f17f9d932c Include gyp as a submodule
This makes it so you don't have to install gyp on your system before you
can build.
2013-08-23 07:48:37 -04:00

44 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Brightray
Brightray is a static library that makes
[libchromiumcontent](https://github.com/brightray/libchromiumcontent) easier to
use in applications.
## Using it in your app
See [brightray_example](https://github.com/brightray/brightray_example) for a
sample application written using Brightray.
## Development
### Prerequisites
* Python 2.7
* Linux:
* Clang 3.0
* Mac:
* Xcode
* Windows:
* Visual Studio 2010 SP1
### One-time setup
You must previously have built and uploaded libchromiumcontent using its
`script/upload` script.
$ script/bootstrap http://base.url.com/used/by/script/upload
### Building
$ script/build
Building Brightray on its own isnt all that interesting, since its just a
static library. Building it into an application (like
[brightray_example](https://github.com/brightray/brightray_example)) is the only
way to test it.
## License
In general, everything is covered by the [`LICENSE`](LICENSE) file. Some files
specify at the top that they are covered by the
[`LICENSE-CHROMIUM`](LICENSE-CHROMIUM) file instead.