README.md 1.99 KB
Newer Older
1
[![Build Status](https://gitlab.gnome.org/GNOME/gjs/badges/master/build.svg)](https://gitlab.gnome.org/GNOME/gjs/pipelines)
Claudio André's avatar
Claudio André committed
2 3
[![Coverage report](https://gitlab.gnome.org/GNOME/gjs/badges/master/coverage.svg)](https://gnome.pages.gitlab.gnome.org/gjs/)
[![Contributors](https://img.shields.io/github/contributors/GNOME/gjs.svg)](https://gitlab.gnome.org/GNOME/gjs/graphs/master)
4
[![LoC](https://tokei.rs/b1/github/GNOME/gjs?category=code)](https://gnome.pages.gitlab.gnome.org/gjs/report.txt)
Claudio André's avatar
Claudio André committed
5
[![Last commit](https://img.shields.io/github/last-commit/GNOME/gjs.svg)](https://gitlab.gnome.org/GNOME/gjs/commits/master)
6
[![Search hit](https://img.shields.io/github/search/GNOME/gjs/goto.svg?label=github%20hits)](https://github.com/search?utf8=%E2%9C%93&q=gjs&type=)
7 8
[![License](https://img.shields.io/badge/License-LGPL%20v2%2B-blue.svg)](https://gitlab.gnome.org/GNOME/gjs/blob/master/COPYING)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://gitlab.gnome.org/GNOME/gjs/blob/master/COPYING)
9 10 11 12 13 14 15 16 17

JavaScript bindings for GNOME
=============================

It's mainly based on Spidermonkey javascript engine and the GObject introspection framework.

Available as part of your GNOME distribution. Powers GNOME Shell, Polari,
GNOME Documents, and many other apps.

Seth Woodworth's avatar
Seth Woodworth committed
18
Wiki: https://gitlab.gnome.org/GNOME/gjs/wikis/Home
19 20

How to build and run if you want to contribute to GJS: see doc/Hacking.md
21

22
## Testing
23 24

Our CI (continuous integration) testing scheme stresses the source code using:
25 26
- Ubuntu 18.04, Fedora 29 (devel), and Ubuntu 18.10 (devel);
- gcc 7.3, gcc 8.1, and clang 6.0;
27
- C/C++ and Javascript Linters;
28
- Code Climate (https://codeclimate.com/);
29 30 31 32 33
- ASAN (address sanitizer) and UBSAN (undefined behavior sanitizer);
- Valgrind (https://en.wikipedia.org/wiki/Valgrind);
- Code Coverage (https://en.wikipedia.org/wiki/Code_coverage);
- Text only and graphics builds;
- Profiler enabled and disabled builds;
34
- ARMv8 and PPC64LE builds;
35 36 37 38 39
- And DevOps with Flatpak.

## License

Dual licensed under LGPL 2.0+ and MIT.