electron/brightray/README.md

44 lines
1 KiB
Markdown
Raw Normal View History

2013-03-13 19:12:05 +00:00
# Brightray
Brightray is a static library that makes
[libchromiumcontent](https://github.com/aroben/libchromiumcontent) easier to
use in applications.
## Using it in your app
See [brightray_example](https://github.com/aroben/brightray_example) for a
sample application written using Brightray.
## Development
2013-05-16 13:08:39 +00:00
### Prerequisites
* Python 2.7
* gyp
* Mac:
* Xcode
* Windows:
* Visual Studio 2010 SP1
2013-03-13 19:12:05 +00:00
### 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/aroben/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.