|
|
@@ -8,18 +8,16 @@ You can stay up-to-date on progress by following the [MSEdge developer blog](htt
|
|
|
|
|
|
## [Build Status](https://github.com/Microsoft/ChakraCore/wiki/Build-Status)
|
|
|
|
|
|
-| | __Debug__ | __Test__ | __Release__ |
|
|
|
-|:-------:|:---------:|:--------:|:-----------:|
|
|
|
-| __x86__ | [![x86debug][x86dbgicon]][x86dbglink] | [![x86test][x86testicon]][x86testlink] | [![x86release][x86relicon]][x86rellink] |
|
|
|
-| __x64__ | [![x64debug][x64dbgicon]][x64dbglink] | [![x64test][x64testicon]][x64testlink] | [![x64release][x64relicon]][x64rellink] |
|
|
|
-| __arm__ | [![armdebug][armdbgicon]][armdbglink] | [![armtest][armtesticon]][armtestlink] | [![armrelease][armrelicon]][armrellink] |
|
|
|
+| | __Debug__ | __Test__ | __Release__ |
|
|
|
+|:-----------------------------:|:---------:|:--------:|:-----------:|
|
|
|
+| __Windows (x64)__ | [![x64debug][x64dbgicon]][x64dbglink] | [![x64test][x64testicon]][x64testlink] | [![x64release][x64relicon]][x64rellink] |
|
|
|
+| __Windows (x86)__ | [![x86debug][x86dbgicon]][x86dbglink] | [![x86test][x86testicon]][x86testlink] | [![x86release][x86relicon]][x86rellink] |
|
|
|
+| __Windows (ARM)__ | [![armdebug][armdbgicon]][armdbglink] | [![armtest][armtesticon]][armtestlink] | [![armrelease][armrelicon]][armrellink] |
|
|
|
+| __Ubuntu 16.04 (x64)__ | [![linuxdebug][linuxdbgicon]][linuxdbglink] | [![linuxtest][linuxtesticon]][linuxtestlink] | [![linuxrelease][linuxrelicon]][linuxrellink] |
|
|
|
+| __Ubuntu 16.04 (x64 static)__ | [![linuxsdebug][linuxsdbgicon]][linuxsdbglink] | [![linuxstest][linuxstesticon]][linuxstestlink] | [![linuxsrelease][linuxsrelicon]][linuxsrellink] |
|
|
|
+| __OS X 10.9 (x64 static)__ | [![osxsdebug][osxsdbgicon]][osxsdbglink] | [![osxstest][osxstesticon]][osxstestlink] | [![osxsrelease][osxsrelicon]][osxsrellink] |
|
|
|
|
|
|
-[x86dbgicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_debug/badge/icon
|
|
|
-[x86dbglink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_debug/
|
|
|
-[x86testicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_test/badge/icon
|
|
|
-[x86testlink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_test/
|
|
|
-[x86relicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_release/badge/icon
|
|
|
-[x86rellink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_release/
|
|
|
+*If you see badges reading "Build: Unknown" it is likely because a build was skipped due to changes being only in files known not to affect the health of the build.*
|
|
|
|
|
|
[x64dbgicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x64_debug/badge/icon
|
|
|
[x64dbglink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x64_debug/
|
|
|
@@ -28,6 +26,13 @@ You can stay up-to-date on progress by following the [MSEdge developer blog](htt
|
|
|
[x64relicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x64_release/badge/icon
|
|
|
[x64rellink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x64_release/
|
|
|
|
|
|
+[x86dbgicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_debug/badge/icon
|
|
|
+[x86dbglink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_debug/
|
|
|
+[x86testicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_test/badge/icon
|
|
|
+[x86testlink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_test/
|
|
|
+[x86relicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_release/badge/icon
|
|
|
+[x86rellink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/x86_release/
|
|
|
+
|
|
|
[armdbgicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/arm_debug/badge/icon
|
|
|
[armdbglink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/arm_debug/
|
|
|
[armtesticon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/arm_test/badge/icon
|
|
|
@@ -35,6 +40,27 @@ You can stay up-to-date on progress by following the [MSEdge developer blog](htt
|
|
|
[armrelicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/arm_release/badge/icon
|
|
|
[armrellink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/arm_release/
|
|
|
|
|
|
+[linuxdbgicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_debug/badge/icon
|
|
|
+[linuxdbglink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_debug/
|
|
|
+[linuxtesticon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_test/badge/icon
|
|
|
+[linuxtestlink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_test/
|
|
|
+[linuxrelicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_release/badge/icon
|
|
|
+[linuxrellink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_release/
|
|
|
+
|
|
|
+[linuxsdbgicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_debug_static/badge/icon
|
|
|
+[linuxsdbglink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_debug_static/
|
|
|
+[linuxstesticon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_test_static/badge/icon
|
|
|
+[linuxstestlink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_test_static/
|
|
|
+[linuxsrelicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_release_static/badge/icon
|
|
|
+[linuxsrellink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/ubuntu_linux_release_static/
|
|
|
+
|
|
|
+[osxsdbgicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/osx_osx_debug_static/badge/icon
|
|
|
+[osxsdbglink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/osx_osx_debug_static/
|
|
|
+[osxstesticon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/osx_osx_test_static/badge/icon
|
|
|
+[osxstestlink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/osx_osx_test_static/
|
|
|
+[osxsrelicon]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/osx_osx_release_static/badge/icon
|
|
|
+[osxsrellink]: http://ci.dot.net/job/Microsoft_ChakraCore/job/master/job/osx_osx_release_static/
|
|
|
+
|
|
|
Above is a table of our rolling build status. We run additional builds on a daily basis. See [Build Status](https://github.com/Microsoft/ChakraCore/wiki/Build-Status) for the status of all builds.
|
|
|
|
|
|
## Security
|
|
|
@@ -59,11 +85,15 @@ You can build ChakraCore on Windows 7 SP1 or above, and Windows Server 2008 R2 o
|
|
|
|
|
|
More details in [Building ChakraCore](https://github.com/Microsoft/ChakraCore/wiki/Building-ChakraCore).
|
|
|
|
|
|
+Alternatively, you can get pre-built ChakraCore binaries from our [NuGet Packages](https://github.com/Microsoft/ChakraCore/wiki/NuGet-Packages).
|
|
|
+
|
|
|
## Using ChakraCore
|
|
|
|
|
|
Once built, you have a few options for how you can use ChakraCore:
|
|
|
|
|
|
-* The most basic is to test the engine is running correctly with the *ch.exe* binary. This app is a lightweight hosting of JSRT that you can use to run small applications. After building, you can find this binary in: `Build\VcBuild\bin\[platform+output]` (eg. `Build\VcBuild\bin\x64_debug`)
|
|
|
+* The most basic is to test the engine is running correctly with the *ch.exe* binary. This app is a lightweight hosting of JSRT that you can use to run small applications. After building, you can find this binary in:
|
|
|
+ * `Build\VcBuild\bin\${platform}_${configuration}`
|
|
|
+ * (e.g. `Build\VcBuild\bin\x64_debug`)
|
|
|
* You can [embed ChakraCore](https://github.com/Microsoft/ChakraCore/wiki/Embedding-ChakraCore) in your applications - see [documentation](https://github.com/Microsoft/ChakraCore/wiki/Embedding-ChakraCore) and [samples](http://aka.ms/chakracoresamples).
|
|
|
* Finally, you can also use ChakraCore as the JavaScript engine in Node. You can learn more by reading how to use [Chakra as Node's JS engine](https://github.com/Microsoft/node)
|
|
|
|
|
|
@@ -77,7 +107,13 @@ Contributions to ChakraCore are welcome. Here is how you can contribute to Chak
|
|
|
* [Submit pull requests](https://github.com/Microsoft/ChakraCore/pulls) for bug fixes and features and discuss existing proposals
|
|
|
* Chat about [@ChakraCore](https://twitter.com/ChakraCore) on Twitter
|
|
|
|
|
|
-Please refer to [Contribution guidelines](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md) for more details.
|
|
|
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
|
|
|
+
|
|
|
+Please refer to [Contribution guidelines](CONTRIBUTING.md) for more details.
|
|
|
+
|
|
|
+## License
|
|
|
+
|
|
|
+Code licensed under the [MIT License](https://github.com/Microsoft/ChakraCore/blob/master/LICENSE.txt).
|
|
|
|
|
|
## Roadmap
|
|
|
For details on our planned features and future direction please refer to our [roadmap](https://github.com/Microsoft/ChakraCore/wiki/Roadmap).
|