[pulseview.git] / INSTALL

-------------------------------------------------------------------------------
INSTALL
-------------------------------------------------------------------------------

Requirements
------------

 - git (only needed when building from git)
 - A C++ compiler with C++11 support (-std=c++11 option), e.g.
   - g++ (>= 4.7)
   - clang++ (>= 3.1)
 - make
 - libtool (only needed when building from git)
 - pkg-config >= 0.22
 - cmake >= 2.8.6
 - libglib >= 2.28.0
 - glibmm-2.4 (>= 2.28.0)
 - Qt4 >= 4.5 or Qt5 (including the following components):
    - Qt4: QtCore, QtGui, QtSvg
    - Qt5: Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
 - libboost >= 1.55 (including the following libs):
    - libboost-system
    - libboost-filesystem
    - libboost-thread
    - libboost-serialization
    - libboost-test (optional, only needed to run the unit tests)
 - libsigrokcxx >= 0.4.0 (libsigrok C++ bindings)
 - libsigrokdecode >= 0.4.0
 - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android)


Building and installing
-----------------------

In order to get the PulseView source code and build it, run:

 $ git clone git://sigrok.org/pulseview
 $ cd pulseview
 $ cmake .
 $ make

For installing PulseView:

 $ make install

See the following wiki page for more (OS-specific) instructions:

 http://sigrok.org/wiki/Building


Creating a source distribution package
--------------------------------------

In order to build a source package begin with an unconfigured source tree.

 $ mkdir dist
 $ cd dist
 $ cmake ..
 $ make package_source
Commit	Line	Data
	1	-------------------------------------------------------------------------------
	2	INSTALL
	3	-------------------------------------------------------------------------------
	4
	5	Requirements
	6	------------
	7
	8	- git (only needed when building from git)
	9	- A C++ compiler with C++11 support (-std=c++11 option), e.g.
	10	- g++ (>= 4.7)
	11	- clang++ (>= 3.1)
	12	- make
	13	- libtool (only needed when building from git)
	14	- pkg-config >= 0.22
	15	- cmake >= 2.8.6
	16	- libglib >= 2.28.0
	17	- glibmm-2.4 (>= 2.28.0)
	18	- Qt4 >= 4.5 or Qt5 (including the following components):
	19	- Qt4: QtCore, QtGui, QtSvg
	20	- Qt5: Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
	21	- libboost >= 1.55 (including the following libs):
	22	- libboost-system
	23	- libboost-filesystem
	24	- libboost-thread
	25	- libboost-serialization
	26	- libboost-test (optional, only needed to run the unit tests)
	27	- libsigrokcxx >= 0.4.0 (libsigrok C++ bindings)
	28	- libsigrokdecode >= 0.4.0
	29	- libsigrokandroidutils >= 0.1.0 (optional, only needed on Android)
	30
	31
	32	Building and installing
	33	-----------------------
	34
	35	In order to get the PulseView source code and build it, run:
	36
	37	$ git clone git://sigrok.org/pulseview
	38	$ cd pulseview
	39	$ cmake .
	40	$ make
	41
	42	For installing PulseView:
	43
	44	$ make install
	45
	46	See the following wiki page for more (OS-specific) instructions:
	47
	48	http://sigrok.org/wiki/Building
	49
	50
	51	Creating a source distribution package
	52	--------------------------------------
	53
	54	In order to build a source package begin with an unconfigured source tree.
	55
	56	$ mkdir dist
	57	$ cd dist
	58	$ cmake ..
	59	$ make package_source
	60