New upstream version 0.5.1+git20170815

1 files changed, 78 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..04f172f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,78 @@
+HARDINFO
+========
+
+HardInfo is a system profiler and benchmark for Linux systems. It is able to
+obtain information from both hardware and basic software, and organize them
+in a simple to use GUI.
+
+Features include:
+- Report generation (in either HTML or plain text)
+- Benchmark result synchronization
+- Ability to explore the information on remote computers
+
+Status
+------
+
+Capabilities: Hardinfo currently decteds software and detected hardware by the OS, mostly almost all.
+Features: the remote sync was disable due server was lost
+Development: currently are made by contribution, a stable and fixed/dedicated maintainer are required.
+
+DEPENDENCIES
+------------
+
+Required:
+- GTK+ 2.10 (or newer)
+- GLib 2.10 (or newer)
+- Zlib (for zlib benchmark)
+
+Optional (for synchronization/remote):
+- Libsoup 2.24 (or newer)
+
+BUILDING
+--------
+
+Create a build directory and build from there:
+
+``` bash
+	hardinfo $ mkdir build
+	hardinfo $ cd build
+	build $ cmake ..
+	build $ make
+```
+
+There are some variables that can be changed:
+
+ * `CMAKE_BUILD_TYPE` : Can be either Release or Debug
+   * `[Default: Release]` Debug builds prints messages to console and are not recommended for general use
+ * `CMAKE_INSTALL_PREFIX` : Sets the installation prefix.
+   * `[Default: /usr/local]` : distributions generalli changes to `/usr`
+ * `HARDINFO_NOSYNC` : Disables network synchronization
+   * `[Default: 1]` : Disabled by default due the server service was lost.
+
+To set a variable, pass use cmake's -D command-line parameter. For example:
+
+`	build $ cmake .. -DCMAKE_BUILD_TYPE=Debug `
+
+Network sync are enabled if libsoup are detected, if having trouble building with libsoup, disable it with:
+
+`	build $ cmake -DHARDINFO_NOSYNC=1`
+
+SETTING UP
+----------
+
+Most things in HardInfo are detected automatically. However, some things
+depends on manual set up. They are:
+
+### Sensors
+
+**lm-sensors**: If your computer is compatible with lm-sensors module, use by example the
+`sensors-detect` program included with the lm-sensors package of Debian based distros, and be sure
+to have the detected kernel modules loaded.
+
+**hddtemp**: To obtain the hard disk drive temperature, be sure to run hddtemp
+in daemon mode, using the default port.
+
+### Memory Speed
+
+The module `eeeprom` mus be loaded to display info about memory hardware instaled.
+Load with `modprobe eeprom` and refres the module screen.