Bläddra i källkod

Update README.md

tags/v0.0.26
Peter Vivell 6 år sedan
förälder
incheckning
57010450f9
1 ändrade filer med 13 tillägg och 4 borttagningar
  1. 13
    4
      README.md

+ 13
- 4
README.md Visa fil

@@ -21,12 +21,17 @@ The `radangel` binary communicates with the RadAngel HID device (`04d8:0100`) vi
21 21
 To grant permissions to the USB device, the udev system can be employed:
22 22
 
23 23
  * `echo 'SUBSYSTEM=="usb", ATTR{idVendor}=="04d8", ATTR{idProduct}=="0100", MODE="0666"' | sudo tee /etc/udev/rules.d/60-kromek-radangel.rules`
24
- * `udevadm control --reload-rules && udevadm trigger`
24
+ * `sudo udevadm control --reload-rules && sudo udevadm trigger`
25 25
 
26
-Compiling the radangel binary for the linux operating system is easy:
27
-Just run `make` in the `src` directory or
26
+Compiling the radangel binary for the linux operating system requires to install some dependencies in advance. To install the build dependencies on a Debian system the apt-get command can be used:
28 27
 
29
-`gcc -std=gnu99 -Wall radangel.c -o radangel -pthread -lm -lhidapi-libusb`
28
+* `apt-get update && apt-get -y install build-essential libc6-dev libhidapi-dev`
29
+
30
+Then you have two options, to compile the binaryJust run `make` in the `src` directory or
31
+
32
+* run `make` in the `src` directory or
33
+
34
+* run `gcc -std=gnu99 -Wall radangel.c -o radangel -pthread -lm -lhidapi-libusb` in the `src` directory
30 35
 
31 36
 The output of the `radangel` daemon consists of two files (time series and histogram):
32 37
 
@@ -47,6 +52,10 @@ and `websockify.service`:
47 52
 *  `datasrc.service` systemd unit employs `inotail` to monitor the output files and streams the changes with `socat` into a tcp socket.
48 53
 *  `websockify.service` launches the `websockify` daemon which provides the websocket endpoint behind `nginx` webserver (see `nginx-datasrc-location.conf`) and translates between websocket and the plain tcp socket.
49 54
 
55
+Again we need to satisfy the dependencies, e.g. on a Debian system with `apt-get`
56
+
57
+* `apt-get update && apt-get -y install build-essential libc6-dev libssl-dev`
58
+
50 59
 To compile the `websockify` daemon just run `make` in the `src/contrib` directory.
51 60
 
52 61
 The web interface itself uses [Plotly.js](https://plot.ly/javascript/) to display the histogram of the channels in realtime by connecting to the websocket endpoint and provides a convenient user interface for exploring the details of the gamma-spectrum.

Laddar…
Avbryt
Spara