.. default-role:: any
.. _intro:
.. default-domain:: bash
		    
Brief introduction to csensors
==============================
Csensors is (currently Linux only) package for visualization of hardware sensors.

Components
----------
* Data pre-processor,/sys scanner :ref:`scan`  
* Detailed configuration GUI tool :ref:`config`
* Applet itself :ref:`applet`

Requirements for source code build
----------------------------------
* `C compiler gcc <http://gcc.gnu.org>`_  or `clang <https://www.llvm.org>`_
* `Perl 5 interpreter <http://www.perl.org>`_
* `cmake <https://cmake.org>`_
* `GNU make <http://savannah.gnu.org/projects/make/>`_ or `ninja <https://ninja-build.org>`_
* `git client <https://git-scm.com>`_
* decent shell (bash)
* `GTK+-3 libraries <http://www.gtk.org>`_
* `Cairo libraries <https://www.cairographics.org>`_
  
Getting source code
===================


.. code-block :: bash

   cd  ~/mysrc/
   git clone https://git.code.sf.net/p/csensors/code csensors
   # code cloned to csensors sub-directory

See [*]_ for optional releases

		 
Configuring and compiling
=========================
Csensors can be compiled in the source directory but this option is deprecated.
The preferred way is build it in a separate build directory.  For example,
if you have unpacked/checkout/cloned csensors directory tree to */usr/src/csensors*,
create a directory */usr/src/csensors-build* to put the object files in.  This
allows removing the whole build directory in case an error occurs,
which is the safest way to get a fresh start and should always be done.

.. code-block :: bash
  
   cd ~/mysrc/csensors
   mkdir Build
   cd Build
   
Configuring and building
------------------------
From your object directory, run cmake -DOPTIONAL_DEFINES ../PATH-TO-UNPACKED-SOURCES :

Configuring and building with make
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block :: bash
  
   cd ~/mysrc/csensors/Build
   cmake -DCMAKE_INSTALL_PREFIX=/usr -DCSENSORS_SYSTEM_CONFIG_DIR=/etc ..
   make
   
Configuring and building with ninja
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have ninja installed, you can save lot of milliseconds by running :

.. code-block :: bash
  
   cd ~/mysrc/csensors/Build
   cmake -GNinja -DCMAKE_INSTALL_PREFIX=/usr -DCSENSORS_SYSTEM_CONFIG_DIR=/etc ..
   ninja
   
Development targets
-------------------
* small applet
* ability to display basic battery and CPU information
* easy integration to fvwm button bar (in my case), gnome panel,
  KDE panel, xfce panel or whatever else.


-------------------

.. [*] <https://sourceforge.net/p/csensors/>
.. image:: ../images/sflogo.svg
   :width: 20%
   :alt: https:sourceforge.net/p/csensors/