]>
Commit | Line | Data |
---|---|---|
1894027b SA |
1 | [[installation,Installation]] |
2 | == Installation | |
3 | ||
4 | PulseView can be run on Linux, Windows, Mac OS X or Android. For some platforms, we provide binary | |
5 | packages, for others we provide installers and for others we provide AppImage containers that | |
6 | you can run without the need to install anything. Check the https://sigrok.org/wiki/Downloads[sigrok download page] | |
7 | to see which option is available for your platform. | |
8 | ||
9 | === Linux | |
10 | ||
11 | On Linux, the usual way to install PulseView is to install the packages provided by your distro's | |
12 | package manager. However, sometimes only outdated packages are made available to you. In that case, | |
13 | you have two options: | |
14 | ||
d1af28a7 | 15 | . https://sigrok.org/wiki/Downloads[Download] and use the AppImage which contains all required files and needs no installation: |
1894027b SA |
16 | + |
17 | -- | |
18 | [listing, subs="normal"] | |
1894027b SA |
19 | chmod u+x PulseView-NIGHTLY-x86_64.AppImage |
20 | ./PulseView-NIGHTLY-x86_64.AppImage | |
21 | ||
22 | Please be aware, however, that the AppImages are built every night, so they always contain | |
23 | the latest development changes. While we do try to keep the code base in a working state, it is sometimes | |
24 | unavoidable to introduce bugs that show up in the nightly builds. If you encounter something that is | |
25 | odd to you, please download and install the latest nightly and check if the issue still exists. If it | |
26 | does, feel free to https://sigrok.org/bugzilla/[file a bug]. | |
27 | ||
28 | No system files are changed, so if you decide that you no longer want to use PulseView, simply | |
29 | delete the AppImage. If you also want the stored settings gone, delete ~/.config/sigrok as well. | |
30 | -- | |
31 | ||
32 | . Uninstall any sigrok packages from your package manager and build PulseView from source: | |
33 | + | |
34 | -- | |
35 | [listing, subs="normal"] | |
36 | _[install dependencies https://sigrok.org/wiki/Linux#Building[as listed on the wiki]]_ | |
37 | mkdir ~/sr | |
38 | cd ~/sr | |
0672b79b | 39 | wget -O sigrok-cross-linux "'https://sigrok.org/gitweb/?p=sigrok-util.git;a=blob_plain;f=cross-compile/linux/sigrok-cross-linux'" |
1894027b SA |
40 | chmod u+x sigrok-cross-linux |
41 | ./sigrok-cross-linux | |
d1af28a7 UH |
42 | export LD_LIBRARY_PATH=~/sr/lib |
43 | ~/sr/bin/pulseview | |
1894027b SA |
44 | |
45 | No system files are changed, so if you decide that you no longer want to use PulseView, simply | |
46 | delete the ~/sr directory. If you also want the stored settings gone, delete ~/.config/sigrok | |
47 | as well. | |
48 | -- | |
49 | ||
50 | [WARNING] | |
51 | -- | |
52 | If you don't install the PulseView distro packages (as is the case when using the AppImage or building | |
53 | from source), PulseView will not be able to access USB and serial port devices unless it's run as root. | |
54 | Since programs shouldn't be run as root unless absolutely necessary, we provide udev configuration files | |
55 | that allows PulseView access to those devices without being root. | |
56 | ||
57 | Here's how you install them: | |
58 | [listing, subs="normal"] | |
59 | sudo bash | |
60 | cd /etc/udev/rules.d/ | |
0672b79b UH |
61 | wget -O 60-libsigrok.rules "'https://sigrok.org/gitweb/?p=libsigrok.git;a=blob_plain;f=contrib/60-libsigrok.rules'" |
62 | wget -O 61-libsigrok-plugdev.rules "'https://sigrok.org/gitweb/?p=libsigrok.git;a=blob_plain;f=contrib/61-libsigrok-plugdev.rules'" | |
63 | wget -O 61-libsigrok-uaccess.rules "'https://sigrok.org/gitweb/?p=libsigrok.git;a=blob_plain;f=contrib/61-libsigrok-uaccess.rules'" | |
1894027b SA |
64 | sudo udevadm control --reload-rules |
65 | -- | |
66 | ||
67 | === Windows | |
68 | ||
69 | We offer installers for PulseView that contain everything you need to get started. Simply download | |
70 | them from the https://sigrok.org/wiki/Downloads[sigrok download page] and run them as any other Windows | |
71 | installer. | |
72 | Please be aware, however, that the Windows installers are built every night, so they always contain | |
73 | the latest development changes. While we do try to keep the code base in a working state, it is sometimes | |
74 | unavoidable to introduce bugs that show up in the nightly builds. If you encounter something that is | |
75 | odd to you, please download and install the latest nightly and check if the issue still exists. If it | |
76 | does, feel free to https://sigrok.org/bugzilla/[file a bug]. | |
77 | ||
78 | After installation, you will find a program called Zadig in the start menu. By default, certain devices | |
79 | recognized by Windows will have drivers installed for them that PulseView cannot use. The purpose of | |
80 | Zadig is to let you change the driver Windows uses for a particular device - for most devices you'll need | |
81 | to choose WinUSB to use them with PulseView or the original proprietary Windows driver to use it with whatever | |
82 | other software you access the device with. More details are available https://sigrok.org/wiki/Windows[in the wiki]. | |
83 | ||
84 | In case your device doesn't show up in PulseView and you can't find it with a scan either (see next | |
85 | chapter), check with Zadig whether the correct driver is assigned for the device. | |
86 | ||
87 | === Mac OS X | |
88 | ||
00c41069 UH |
89 | We offer DMG installers for PulseView that contain everything you need to get started. Simply download |
90 | them from the https://sigrok.org/wiki/Downloads[sigrok download page] and run them. | |
1894027b | 91 | |
00c41069 UH |
92 | Please be aware, however, that the DMG installers are built every night, so they always contain |
93 | the latest development changes. While we do try to keep the code base in a working state, it is sometimes | |
94 | unavoidable to introduce bugs that show up in the nightly builds. If you encounter something that is | |
95 | odd to you, please download and install the latest nightly and check if the issue still exists. If it | |
96 | does, feel free to https://sigrok.org/bugzilla/[file a bug]. | |
1894027b | 97 | |
00c41069 UH |
98 | No system files are changed, so if you decide that you no longer want to use PulseView, simply |
99 | delete the DMG file. If you also want the stored settings gone, delete | |
100 | ~/Library/Preferences/pulseview.plist as well. |