doc update

This commit is contained in:
Johannes Findeisen 2018-03-20 23:07:35 +01:00
commit 9cf06f8f23

View file

@ -1,7 +1,7 @@
dooris-gtk SpaceAPI-GTK
========== ============
Menubar item for GTK2 showing the Dooris status compatible with the SpaceAPI version 0.13. A panel Applet using GTK2 for showing the Status of a Hackerspace. Compatible with the SpaceAPI version 0.13.
Installation: Installation:
------------- -------------
@ -16,11 +16,11 @@ Requirements:
Use the following command for getting the sources: Use the following command for getting the sources:
git clone https://github.com/ccchh/dooris-gtk.git git clone https://github.com/hanez/SpaceAPI-GTK.git
Change into the new directory: Change into the new directory:
cd dooris-gtk cd SpaceAPI-GTK
To compile the sources just run: To compile the sources just run:
@ -30,30 +30,34 @@ This will compile dooris with libnotify support.
If you don't want notifications run the following comand: If you don't want notifications run the following comand:
gcc `pkg-config --cflags --libs gtk+-2.0 --libs libcurl --libs json-c` -o dooris dooris.c gcc `pkg-config --cflags --libs gtk+-2.0 --libs libcurl --libs json-c` -o spaceapi-gtk spaceapi-gtk.c
Installation Installation
------------ ------------
Just copy "dooris" to a folder in your $PATH. I do: Just copy "dooris" to a folder in your $PATH. I do:
cp ./dooris ~/bin/ cp ./spaceapi-gtk ~/bin/
You can copy the file to /usr/bin to make it available for all users but I don't. If you want that just run: You can copy the file to /usr/bin to make it available for all users but I don't. If you want that just run:
sudo cp ./dooris /usr/bin/ sudo cp ./spaceapi-gtk /usr/bin/
Configuration: Configuration:
-------------- --------------
Configuration needs to be done before compiling. There are some parameters you can set in the head of the dooris.c file where variables are declared. A configuration file will at this point make no sense. Configuration needs to be done before compiling. There are some parameters you can set in the head of the spaceapi-gtk.c file where variables are declared. A configuration file will at this point make no sense.
Usage: Usage:
------ ------
Run dooris with: Run spaceapi-gtk with:
./dooris & ./spaceapi-gtk &
Or if in your $PATH:
spaceapi-gtk
Status Icon "Pesthörnchen" colors: Status Icon "Pesthörnchen" colors: