node-glib
A wrapper for the GLib library.
This module proxies the most useful GLib interfaces, most notably the Gio part, for use with JS.
Install
This module can only run on OS that support the GLib library. It means that it can run on Linux machines with GNOME as a WM.
You will need GLib and Gio installed:
sudo apt-get install glibmm-2.4 giomm-2.4npm install --save node-glibRun tests
cd node-glib/npm installnpm testUsage
TODO
Contributing
All contributions are welcome! In order to have a consistent repo, we however ask you to comply to the following conventions whenever possible.
1. Commit tags
All commits should be tagged with emojis to make the commit list more readable.
| Emoji | Commit content |
|---|---|
| 📖 | Documentation updates |
| 🐛 | Bug fixes |
| 📒 | Rename/move files |
| 💡 | Features |
| 💄 | Fix coding style |
2. Branches
Please use a branch name that differs from master whenever possible,
when making pull requests, so that the network history is more
readable.
For example, if you wanted to fix the issue
"improve documentation", you could have
chosen the following branch name: improve-docs.
3. Coding style
Javascript can be authored by following a lot of different style guides but we decided to be a bit soft on that.
Just follow the conventions that are encoded into the .eslintrc
configuration file. By the way, be sure to check out ESLint,
which is a great toolable style checker.
- Use the radix parameter in
parseInt()calls. - Declare all your variables at the top of the functions.
- Use the one true brace style.
- Put one space after commas, and no space before.
- Put your comma at the end of the lines.
- Use simple quotes.
- Use camelcase.
- Use 4 spaces for indentation.
License
See LICENSE.