summaryrefslogtreecommitdiff
path: root/dependencies.txt
blob: 537b4117c183324317c63bc73fa04d0a114f8c11 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Hard dependencies
=================

The following packages have to be installed (for Fedora)

- cmake
- mozjs24-devel (for the mandatory mozjs plugin)
- expat-devel (for the mandatory XML format)

Test dependencies
=================

Tests are based on the gtest library. Run the ./lib/download_dependencies.sh script to fetch this dependency.

Documentation
=============

In order to build the documentation (make doc)

- doxygen

Tools
=====

Automated code formating (clang-format)
---------------------------------------

Download Pre-built binary of "LLVM" from

http://llvm.org/releases/download.html

use the "clang-format" program in the bin/ directory. The following gedit tool can be used for automated code formating:

(Activate the "External Tools" plugin, add the following lines to .config/gedit/tools/clang-format, without indentation)

	#!/bin/sh
	# [Gedit Tool]
	# Input=document
	# Shortcut=<Shift><Alt>f
	# Applicability=all
	# Save-files=nothing
	# Output=replace-document
	# Name=Clang Format


	cd $GEDIT_CURRENT_DOCUMENT_DIR && <INSERT CORRECT PATH HERE>/clang-format