added readme directory

PKGBUILD

@@ -18,7 +18,7 @@ optdepends=("hddtemp: for HDD temperature monitor"
 makedepends=('automoc4' 'cmake')
 source=(https://github.com/arcan1s/pytextmonitor/releases/download/V.${pkgver}/${_pkgname}-${pkgver}-src.tar.xz)
 install=${pkgname}.install
-md5sums=('f2e54037fec38726035ba04cb61f6b6d')
+md5sums=('54bb5f51bdae4cf2e8fc36dc0cdbf9d4')
 backup=('usr/share/config/extsysmon.conf')
 
 prepare() {

create_archive.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# update english readme
+cp readme/en.md README.md
+
 SRCDIR="sources"
 VERSION=$(grep -m1 PROJECT_VERSION_MAJOR sources/CMakeLists.txt | awk '{print $3}' | cut -c 1).\
 $(grep -m1 PROJECT_VERSION_MINOR sources/CMakeLists.txt | awk '{print $3}' | cut -c 1).\
@@ -16,13 +19,13 @@ rm -rf "${ARCHIVE}"
 
 # build widget
 ARCHIVE="pytextmonitor"
-FILES="AUTHORS CHANGELOG CHANGELOG-RU COPYING README.md"
+FILES="AUTHORS CHANGELOG CHANGELOG-RU COPYING readme"
 IGNORELIST="build usr"
 # create archive
 [[ -e ${ARCHIVE}-${VERSION}-src.tar.xz ]] && rm -f "${ARCHIVE}-${VERSION}-src.tar.xz"
 [[ -d ${ARCHIVE} ]] && rm -rf "${ARCHIVE}"
 cp -r "${SRCDIR}" "${ARCHIVE}"
-for FILE in ${FILES[*]}; do cp "$FILE" "${ARCHIVE}"; done
+for FILE in ${FILES[*]}; do cp -r "$FILE" "${ARCHIVE}"; done
 for FILE in ${IGNORELIST[*]}; do rm -rf "${ARCHIVE}/${FILE}"; done
 tar cJf "${ARCHIVE}-${VERSION}-src.tar.xz" "${ARCHIVE}" 
 rm -rf "${ARCHIVE}"

readme/en.md

@@ -0,0 +1,188 @@
+pytextmonitor
+=============
+
+Information
+-----------
+PyTextMonitor is a minimalistic Plasmoid script written on Python2. It looks like widgets in awesome-wm.
+
+**NOTE** LOOKING FOR TRANSLATORS!
+
+Configuration
+-------------
+For edited output you must open Settings window and setup output format in lines:
+* tag `$time` - time in default format. For example, *fri Nov 6 04:48:01 2013*
+* tag `$isotime` - time in iso format
+* tag `$shorttime` - time in short locale format
+* tag `$longtime` - time in long locale format
+* tag `$custom` - custom time format
+* tag `$uptime` - uptime, *---d--h--m*
+* tag `$custom` - custom uptime format
+* tag `$cpu` - total load cpu, *%*
+* tag `$cpuN` - load CPU for core N, *%*. N should be in range 0 to 8
+* tag `$cpucl` - average cpu clock, *MHz*
+* tag `$cpuclN` - cpu clock for core N, *MHz*. N should be in range 0 to 8
+* tag `$tempN` - temperature for device N. For example, `$temp0`
+* tag `$gpu` - GPU usage, *%*. `aticonfig` or `nvidia-smi` must be installed
+* tag `$gputemp` - GPU temperature. `aticonfig` or `nvidia-smi` must be installed
+* tag `$mem` - usage memory, *%*
+* tag `$memmb` - usage memory, *MB*
+* tag `$swap` - swap, *%*
+* tag `$swapmb` - swap, *MB*
+* tag `$hddN` - usage for mount point N, *%*. For example, `$hdd0`
+* tag `$hddtempN` - temperature for HDD N. For example, `$hddtemp0`
+* tag `$down` - download speed, *KB/s*
+* tag `$up` - upload speed, *KB/s*
+* tag `$netdev` - current network device
+* tag `$bat` - battery charge, *%*
+* tag `$ac` - status AC device. Return (\*) if AC device is online or *( )* if offline
+* tag `$album` - current song album. One of supported music players must be installed
+* tag `$artist` - current song artist. One of supported music players must be installed
+* tag `$progress` - current song progress. One of supported music players must be installed
+* tag `$time` - current song duration. One of supported music players must be installed
+* tag `$title` - current song title. One of supported music players must be installed
+* tag `$custom` - returns output for custom command
+
+Label order will changed if you change slider position. HTML tags in label work normally.
+
+**NOTE** you don't may set to show `$cpu` tag in swap label for example. **`$cpu` will work only in cpu label**.
+
+Advanced settings
+-----------------
+**Custom time**
+
+* tag `$dddd` - weekday in long format
+* tag `$ddd` - weekday in short format
+* tag `$dd` - day
+* tag `$d` - day without zero
+* tag `$MMMM` - month in long format
+* tag `$MMM` - month in short format
+* tag `$MM` - month
+* tag `$M` - month without zero
+* tag `$yyyy` - year
+* tag `$yy` - year in short format
+* tag `$hh` - hours
+* tag `$h` - hours without zero
+* tag `$mm` - minutes
+* tag `$m` - minutes without zero
+* tag `$ss` - seconds
+* tag `$s` - seconds without zero
+
+**Custom uptime**
+
+* tag `$dd` - uptime days
+* tag `$d` - uptime days without zero
+* tag `$hh` - uptime hours
+* tag `$h` - uptime hours without zero
+* tag `$mm` - uptime minutes
+* tag `$m` - uptime minutes without zero
+
+**Temperature devices**
+
+List of devices, which will be observed in temp label (combo box items come from `sensors`). List widget is editable, delete key will remove current item.
+
+**Mount points**
+
+List of mount points, which will be observed in hdd label (combo box items come from `mount`). List widget is editable, delete key will remove current item.
+
+**HDD**
+
+List of hard disk devices, which will be observed in hddtem label (combo box items come from `find`). List widget is editable, delete key will remove current item.
+
+**Network directory**
+
+Path to directory, which contains network devices information. Default is `/sys/class/net`. Required for auto select network device.
+
+**Network device**
+
+Use specified device as active. Combo box items come from **network directory**. Will disable auto select network device.
+
+**Battery device**
+
+File with battery information. File (`/sys/class/power_supply/BAT0/capacity` by default) should contain only battery charge in percent.
+
+**AC device**
+
+File with AC information. File (`/sys/class/power_supply/AC/online` by default) must contain `1` if AC is online.
+
+**Music player**
+
+Select one of supported music playes for player label.
+
+Tooltip settings
+----------------
+Since version 1.7.0 CPU, CPU clock, memory, swap and network labels support graphical tooltip. To enable them just make the needed checkboxes a fully checked. The number of stored values can be set in the tab. Colors of graphs are configurable too.
+
+DataEngine settings
+-------------------
+**GPU device**
+
+Select one of supported GPU devices. `auto` will enable auto selection. Default is `auto`.
+
+**HDD**
+
+Select one of HDDs for HDD temperature monitor. `all` will enable monitor for all devices. Default is `all`.
+
+**MPD address**
+
+Address of MPD server. Default is `localhost`.
+
+**MPD port**
+
+Port of MPD server. Default is `6600`.
+
+**Custom command**
+
+*NOTE* This can cause the computer freeze.
+
+A command, which will be run for custom label.
+
+DataEngine configuration
+------------------------
+You may edit DataEngine configuration. It is `/usr/share/config/extsysmon.conf` or `$HOME/share/config/extsysmon.conf` depending on the type of installation. Uncomment needed line and edit it.
+
+Instruction
+===========
+
+Dependencies
+------------
+* kdebase-workspace
+* kdebindings-python2
+* lm_sensors (*for definition temperature device*)
+* sysstat (*for notification*)
+
+Optional dependencies
+---------------------
+* proprietary video driver
+* hddtemp (make sure that it may be run with `sudo` without password. Just add following line to `/etc/sudoers`: `$USERNAME ALL=NOPASSWD: /usr/bin/hddtemp`)
+* music player (amarok, mpd or qmmp)
+
+Make dependencies
+-----------------
+* automoc4
+* cmake
+* kdebase-runtime
+
+Installation
+------------
+* download sources
+* install
+
+        mkdir build && cd build
+        cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`kde4-config --localprefix` ../
+        make && make install
+
+  Also you may install it to `/`:
+
+        mkdir build && cd build
+        cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` ../
+        make && sudo make install
+
+Additional information
+======================
+
+Links
+-----
+* [Homepage](http://arcanis.name/projects/pytextmonitor/)
+* Plasmoid on [kde-look](http://kde-look.org/content/show.php/Py+Text+Monitor?content=157124)
+* DataEngine on [kde-look](http://kde-look.org/content/show.php/Extended+Systemmonitor+DataEngine?content=158773)
+* Archlinux [AUR](https://aur.archlinux.org/packages/kdeplasma-applets-pytextmonitor/) package

readme/ru.md

@@ -0,0 +1,186 @@
+pytextmonitor
+=============
+
+Информация
+----------
+PyTextMonitor - минималистичный плазмоид, написанный на Python2. Он выглядит, как виджеты в Awesome WM.
+
+Настройка
+---------
+Для редактирования внешнего виде, откройте окно настроек и установите требуемый формат в поля:
+* тэг `$time` - время в стандартном формате. Например, *fri Nov 6 04:48:01 2013*
+* тэг `$isotime` - время в ISO формате
+* тэг `$shorttime` - время в коротком формате
+* тэг `$longtime` - время в длинном формате
+* тэг `$custom` - свой формат времени
+* тэг `$uptime` - время работы, *---d--h--m*
+* тэг `$custom` - свой формат аптайма
+* тэг `$cpu` - общая загрузка CPU, *%*
+* тэг `$cpuN` - загрузка CPU для ядра N, *%*. N должно быть в промежутке от 0 до 8
+* тэг `$cpucl` - средняя частота CPU, *MHz*
+* тэг `$cpuclN` - частота CPU для ядра N, *MHz*. N должно быть в промежутке от 0 до 8
+* тэг `$tempN` - температура для устройства N. Например, `$temp0`
+* тэг `$gpu` - использование GPU, *%*. `aticonfig` или `nvidia-smi` должны быть установлены
+* тэг `$gputemp` - температура GPU. `aticonfig` или `nvidia-smi` должны быть установлены
+* тэг `$mem` - использование RAM, *%*
+* тэг `$memmb` - использование RAM, *MB*
+* тэг `$swap` - swap, *%*
+* тэг `$swapmb` - swap, *MB*
+* тэг `$hddN` - использование точки монтирования N, *%*. Например, `$hdd0`
+* тэг `$hddtempN` - температура HDD N. Например, `$hddtemp0`
+* тэг `$down` - скорость загрузки, *KB/s*
+* тэг `$up` - скорость отдачи, *KB/s*
+* тэг `$netdev` - текущий сетевой интерфейс
+* тэг `$bat` - заряд батареи, *%*
+* тэг `$ac` - статус адаптора питания. Возвращает (\*), если AC подключен или *( )*, если нет
+* тэг `$album` - альбом. Один из поддерживаемых плееров должен быть установлен
+* тэг `$artist` - исполнитель. Один из поддерживаемых плееров должен быть установлен
+* тэг `$progress` - прогресс. Один из поддерживаемых плееров должен быть установлен
+* тэг `$time` - длительность. Один из поддерживаемых плееров должен быть установлен
+* тэг `$title` - название. Один из поддерживаемых плееров должен быть установлен
+* тэг `$custom` - возвращает результат своей команды
+
+Порядок полей изменится, если вы измените позицию слайдеров. HTML тэги в полях работают корректно.
+
+**ЗАМЕЧАНИЕ** вы не можете установить тэг `$cpu`, например, в поле swap. **`$cpu` будет работать только в поле CPU**.
+
+Расширенные настройки
+---------------------
+**Свой формат времени**
+
+* тэг `$dddd` - день недели в длинном формате
+* тэг `$ddd` - день недели в коротком формате
+* тэг `$dd` - день
+* тэг `$d` - день без нуля
+* тэг `$MMMM` - месяц в длинном формате
+* тэг `$MMM` - месяц в коротком формате
+* тэг `$MM` - месяц
+* тэг `$M` - месяц без нуля
+* тэг `$yyyy` - год
+* тэг `$yy` - год в коротком формате
+* тэг `$hh` - часы
+* тэг `$h` - часы без нуля
+* тэг `$mm` - минуты
+* тэг `$m` - минуты без нуля
+* тэг `$ss` - секунды
+* тэг `$s` - секунды без нуля
+
+**Свой формат аптайма**
+
+* тэг `$dd` - дни аптайма
+* тэг `$d` - дни аптайма без нуля
+* тэг `$hh` - часы аптайма
+* тэг `$h` - часы аптайма без нуля
+* тэг `$mm` - минуты аптайма
+* тэг `$m` - минуты аптайма без нуля
+
+**Датчики температуры**
+
+Список датчиков, которые будут наблюдаться в поле temo (содержимое комбо бокса берется из `sensors`). Виджет редактируем, клавиша delete удалит текущую строку.
+
+**Точки монтирования**
+
+Список точек монтирования, которые будут наблюдаться в поле hdd (содержимое комбо бокса берется из `mount`). Виджет редактируем, клавиша delete удалит текущую строку.
+
+**HDD**
+
+Список HDD, которые будут наблюдаться в поле hddtemp (содержимое комбо бокса берется из `find`). Виджет редактируем, клавиша delete удалит текущую строку.
+
+**Директория с сетевыми интерфейсами**
+
+Путь к директории, которая содержит информацию о сетевых интерфейсах. По умолчанию `/sys/class/net`. Требуется для определения сетевого устройства.
+
+**Сетевое устройство**
+
+Использовать указанный интерфейс, как активный. Содержимое комбо бокса берется из **директории с сетевыми интерфейсами**. Эта опция отключит авто определение интерфейса.
+
+**Устройство батареи**
+
+Файл с информацией о батарее. Данный файл (`/sys/class/power_supply/BAT0/capacity` по умолчанию) должен содержать только заряд батареи в процентах.
+
+**Устройство AC**
+
+Файл с информацией об адапторе питания. Данный файл (`/sys/class/power_supply/AC/online` по умолчанию) должен содержать `1`, если адаптор подключен.
+
+**Музыкальные плеер**
+
+Выберете один из поддерживаемых музыкальных плееров.
+
+Настройки тултипа
+-----------------
+Начиная с версии 1.7.0 поля CPU, частота CPU, память, swap и сеть поддерживают графический тултип. Чтобы включить их, просто сделайте требуемые чекбоксы полностью чекнутыми. Число хранимых значений может быть выставленно в данной вкладке. Цвета графиков также настраиваются.
+
+Настройки DataEngine
+--------------------
+**Устройство GPU**
+
+Выберете одно из поддерживаемых устройств GPU. `auto` включит автоматическое определение. По умолчанию `auto`.
+
+**HDD**
+
+Выберете один из HDD для монитора его температуры. `all` включит монитор для всех доступных устройств. По умолчанию `all`.
+
+**Адрес MPD**
+
+Адрес MPD сервера. По умолчанию `localhost`.
+
+**Порт MPD**
+
+Порт MPD сервера. По умолчанию `6600`.
+
+**Своя команда**
+
+*ЗАМЕЧАНИЕ* Может вызвать зависание компьютера.
+
+Команда, которая будет запущена для соответствующего поля.
+
+Настройка DataEngine
+--------------------
+Вы можете отредактировать настройки DataEngine вручную. Откройте файл `/usr/share/config/extsysmon.conf` или `$HOME/.kde4/share/config/extsysmon.conf`, в зависимости от типа установки. Раскомментируйте требуемые строки и отредактируйте их.
+
+Инструкция
+==========
+
+Зависимости
+-----------
+* kdebase-workspace
+* kdebindings-python2
+* lm_sensors (*для определения датчиков температуры*)
+* sysstat (*для уведомлений*)
+
+Опциональные зависимости
+------------------------
+* проприетарный видеодрайвер
+* hddtemp (убедитесь, что может быть запущен с `sudo` без пароля. Просто добавьте следующую строку в `/etc/sudoers`: `$USERNAME ALL=NOPASSWD: /usr/bin/hddtemp`)
+* музыкальный плеер (amarok, mpd или qmmp)
+
+Зависимости сборки
+------------------
+* automoc4
+* cmake
+* kdebase-runtime
+
+Установка
+---------
+* скачать исходный архив
+* установить
+
+        mkdir build && cd build
+        cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`kde4-config --localprefix` ../
+        make && make install
+
+  Для установки в `/`:
+
+        mkdir build && cd build
+        cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` ../
+        make && sudo make install
+
+Дополнительная информация
+=========================
+
+Ссылки
+------
+* [Домашняя страница](http://arcanis.name/projects/pytextmonitor/)
+* Виджет на [kde-look](http://kde-look.org/content/show.php/Py+Text+Monitor?content=157124)
+* DataEngine на [kde-look](http://kde-look.org/content/show.php/Extended+Systemmonitor+DataEngine?content=158773)
+* Пакет для Archlinux в [AUR](https://aur.archlinux.org/packages/kdeplasma-applets-pytextmonitor/)