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