mirror of
https://github.com/arcan1s/arcanis.me.git
synced 2025-07-15 06:05:47 +00:00
more pretty md files
This commit is contained in:
@ -15,7 +15,8 @@ links:
|
||||
---
|
||||
<!-- info block -->
|
||||
|
||||
Simple daemon that automatically creates git repository in the given directory and creates commit at the specified time interval.
|
||||
Simple daemon that automatically creates git repository in the given directory
|
||||
and creates commit at the specified time interval.
|
||||
|
||||
<!--more-->
|
||||
|
||||
@ -63,7 +64,8 @@ See "man 1 ctrlconf" for more details
|
||||
|
||||
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Instruction
|
||||
|
||||
* Download an [archive](//github.com/arcan1s/git-etc/releases "GitHub") with latest version of source files.
|
||||
* Download an [archive](//github.com/arcan1s/git-etc/releases "GitHub") with
|
||||
latest version of source files.
|
||||
* Extract it and install the application:
|
||||
|
||||
```bash
|
||||
@ -106,7 +108,8 @@ If you want to enable daemon autoload run
|
||||
systemctl enable git-etc
|
||||
```
|
||||
|
||||
But you may change path to configuration file or change parameters. To do it just copy (recommended) the source configuration file to new path
|
||||
But you may change path to configuration file or change parameters. To do it just
|
||||
copy (recommended) the source configuration file to new path
|
||||
|
||||
```bash
|
||||
cp /etc/git-etc.conf /new/path/to/file/git-etc.conf
|
||||
@ -134,7 +137,8 @@ ExecStart=/usr/bin/git-etc -c /new/path/to/file/git-etc.conf
|
||||
<!-- config block -->
|
||||
## <a href="#config" class="anchor" id="config"><span class="octicon octicon-link"></span></a>Configuration
|
||||
|
||||
All settings are stored in `/etc/git-etc.conf`. After edit them you must restart daemon
|
||||
All settings are stored in `/etc/git-etc.conf`. After edit them you must restart
|
||||
daemon
|
||||
|
||||
```bash
|
||||
systemctl restart git-etc
|
||||
@ -153,7 +157,13 @@ systemctl restart git-etc
|
||||
<!-- gui block -->
|
||||
## <a href="#gui" class="anchor" id="gui"><span class="octicon octicon-link"></span></a>Graphical user interface
|
||||
|
||||
Control Config (`ctrlconf`) is GUI for `git-etc` daemon written on `Python2/PyQt4`. This application allows you to view a list of commits and changes in files recorded in commit messages. Also, this application allows you to roll back to a specific commit all files (`git reset --hard`) or individual files (`git diff && git apply`). And you may merge old and new configuration files (used two branches repository - master and experimental). The application may need root privileges. Make sure that `sudo` package is installed.
|
||||
Control Config (`ctrlconf`) is GUI for `git-etc` daemon written on `Python2/PyQt4`.
|
||||
This application allows you to view a list of commits and changes in files recorded
|
||||
in commit messages. Also, this application allows you to roll back to a specific
|
||||
commit all files (`git reset --hard`) or individual files (`git diff && git apply`).
|
||||
And you may merge old and new configuration files (used two branches repository -
|
||||
master and experimental). The application may need root privileges. Make sure that
|
||||
`sudo` package is installed.
|
||||
|
||||
### <a href="#gui_configuration" class="anchor" id="gui_configuration"><span class="octicon octicon-link"></span></a>Configuration
|
||||
|
||||
|
@ -27,11 +27,15 @@ links:
|
||||
---
|
||||
<!-- info block -->
|
||||
|
||||
A collection of minimalistic easily configurable Plasmoids written on `C++/Qt`. They look like widgets in [Awesome WM](//awesome.naquadah.org/ "Awesome Homepage"). Also this packages has an additional system [DataEngine](//techbase.kde.org/Development/Tutorials/Plasma/DataEngines "Developers tutorial").
|
||||
A collection of minimalistic easily configurable Plasmoids written on `C++/Qt`.
|
||||
They look like widgets in [Awesome WM](//awesome.naquadah.org/ "Awesome Homepage").
|
||||
Also this packages has an additional system [DataEngine]
|
||||
(//techbase.kde.org/Development/Tutorials/Plasma/DataEngines "Developers tutorial").
|
||||
|
||||
<!--more-->
|
||||
|
||||
**NOTE:** [LOOKING FOR TRANSLATORS!](//github.com/arcan1s/awesome-widgets/issues/14 "Ticket")
|
||||
**NOTE:** [LOOKING FOR TRANSLATORS!](//github.com/arcan1s/awesome-widgets/issues/14
|
||||
"Ticket")
|
||||
|
||||
**PLASMA 5 COMPATIBLE!**
|
||||
|
||||
@ -55,7 +59,8 @@ A collection of minimalistic easily configurable Plasmoids written on `C++/Qt`.
|
||||
|
||||
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Instruction
|
||||
|
||||
* Download an [archive](//github.com/arcan1s/awesome-widgets/releases "GitHub") with latest version of source files.
|
||||
* Download an [archive](//github.com/arcan1s/awesome-widgets/releases "GitHub")
|
||||
with latest version of source files.
|
||||
* Extract it and install:
|
||||
|
||||
```bash
|
||||
@ -66,7 +71,8 @@ A collection of minimalistic easily configurable Plasmoids written on `C++/Qt`.
|
||||
sudo make install
|
||||
```
|
||||
|
||||
**NOTE:** on Plasma 5 it very likely requires `-DKDE_INSTALL_USE_QT_SYS_PATHS=ON` flag
|
||||
**NOTE:** on Plasma 5 it very likely requires `-DKDE_INSTALL_USE_QT_SYS_PATHS=ON`
|
||||
flag.
|
||||
|
||||
### <a href="#dependencies" class="anchor" id="dependencies"><span class="octicon octicon-link"></span></a>Dependencies
|
||||
|
||||
@ -88,7 +94,8 @@ Open your Plasma widgets and select `Awesome Widget`.
|
||||
|
||||
### <a href="#tips" class="anchor" id="tips"><span class="octicon octicon-link"></span></a>Tips & tricks
|
||||
|
||||
You may use different colours inside. Just put label text into html code. See [issue](//github.com/arcan1s/awesome-widgets/issues/9 "GitHub") for more details.
|
||||
You may use different colours inside. Just put label text into html code. See
|
||||
[issue](//github.com/arcan1s/awesome-widgets/issues/9 "GitHub") for more details.
|
||||
|
||||
<!-- end of howto block -->
|
||||
|
||||
@ -97,7 +104,9 @@ You may use different colours inside. Just put label text into html code. See [i
|
||||
|
||||
### <a href="#deconf" class="anchor" id="deconf"><span class="octicon octicon-link"></span></a>DataEngine configuration
|
||||
|
||||
You may edit DataEngine configuration. It is `/etc/xdg/plasma-dataengine-extsysmon.conf` and `$HOME/.config/plasma-dataengine-extsysmon.conf`. Uncomment needed line and edit it.
|
||||
You may edit DataEngine configuration. It is `/etc/xdg/plasma-dataengine-extsysmon.conf`
|
||||
and `$HOME/.config/plasma-dataengine-extsysmon.conf`. Uncomment needed line and
|
||||
edit it.
|
||||
|
||||
#### <a href="#deoptions" class="anchor" id="deoptions"><span class="octicon octicon-link"></span></a>DataEngine options
|
||||
|
||||
@ -114,7 +123,8 @@ You may edit DataEngine configuration. It is `/etc/xdg/plasma-dataengine-extsysm
|
||||
|
||||
### <a href="#widconf" class="anchor" id="widconf"><span class="octicon octicon-link"></span></a>Widget configuration
|
||||
|
||||
For edited output you must open Settings window and setup output format. HTML tags work normally.
|
||||
For edited output you must open Settings window and setup output format. HTML
|
||||
tags work normally.
|
||||
|
||||
Available flags are in the table below.
|
||||
|
||||
@ -217,7 +227,9 @@ Available flags are in the table below.
|
||||
|
||||
##### <a href="#lambda" class="anchor" id="lambda"><span class="octicon octicon-link"></span></a>Lambda functions
|
||||
|
||||
Since version 3.0.0 the main widgets supports lambda functions, which are calculated at runtime. It may be declared by using `{% raw %}${{{% endraw %} {% raw %}}}{% endraw %}` construction:
|
||||
Since version 3.0.0 the main widgets supports lambda functions, which are
|
||||
calculated at runtime. It may be declared by using `{% raw %}${{{% endraw %}
|
||||
{% raw %}}}{% endraw %}` construction:
|
||||
|
||||
```javascript
|
||||
{% raw %}${{{% endraw %}
|
||||
@ -229,7 +241,8 @@ three()
|
||||
{% raw %}}}{% endraw %}
|
||||
```
|
||||
|
||||
A functions inside will be interpret as JavaScript ones, any variables from main body is supported, thus the following function:
|
||||
A functions inside will be interpret as JavaScript ones, any variables from main
|
||||
body is supported, thus the following function:
|
||||
|
||||
```javascript
|
||||
{% raw %}${{{% endraw %}
|
||||
@ -244,7 +257,8 @@ colorCpu()
|
||||
{% raw %}}}{% endraw %}
|
||||
```
|
||||
|
||||
will show `$cpu` value in red if it is more than 90.0, otherwise it will be shown in default colour. Any calculations are also supported:
|
||||
will show `$cpu` value in red if it is more than 90.0, otherwise it will be shown
|
||||
in default colour. Any calculations are also supported:
|
||||
|
||||
```javascript
|
||||
{% raw %}${{{% endraw %}
|
||||
@ -252,7 +266,10 @@ $down - $up
|
||||
{% raw %}}}{% endraw %}
|
||||
```
|
||||
|
||||
will show difference between download and upload speed. Another feature provided by lambda functions is `$this` value which returns the last value of the lambda function. Here is a little more complicated example which will show running line "Artist - Title" with length less or equal than 20 symbols:
|
||||
will show difference between download and upload speed. Another feature provided
|
||||
by lambda functions is `$this` value which returns the last value of the lambda
|
||||
function. Here is a little more complicated example which will show running line
|
||||
"Artist - Title" with length less or equal than 20 symbols:
|
||||
|
||||
```javascript
|
||||
{% raw %}${{{% endraw %}
|
||||
@ -268,11 +285,15 @@ runningLine()
|
||||
{% raw %}}}{% endraw %}
|
||||
```
|
||||
|
||||
Thus this feature may be used for example to show any custom values which will be calculated in runtime and to show different information depending on some conditions. But please keep in mind that such runtime calculation may increase CPU load.
|
||||
Thus this feature may be used for example to show any custom values which will
|
||||
be calculated in runtime and to show different information depending on some
|
||||
conditions. But please keep in mind that such runtime calculation may increase
|
||||
CPU load.
|
||||
|
||||
##### <a href="#advanced" class="anchor" id="advanced"><span class="octicon octicon-link"></span></a>Advanced settings
|
||||
|
||||
**Enable background:** Uncheck to disable default background and set transparent one. Default is `true`.
|
||||
**Enable background:** Uncheck to disable default background and set transparent
|
||||
one. Default is `true`.
|
||||
|
||||
**Translate strings:** Translate strings tags. Default is `true`.
|
||||
|
||||
@ -280,19 +301,24 @@ Thus this feature may be used for example to show any custom values which will b
|
||||
|
||||
**Word wrap:** Enable word wrap. Default is `false`.
|
||||
|
||||
**Enable popup:** Uncheck box if you do not want popup messages on system events. Default is `true`.
|
||||
**Enable popup:** Uncheck box if you do not want popup messages on system events.
|
||||
Default is `true`.
|
||||
|
||||
**Check updates:** Check updates on load. Default is `true`.
|
||||
|
||||
**Widget height:** Disable automatic widget height definition and set it to this value. Default is `0` (auto).
|
||||
**Widget height:** Disable automatic widget height definition and set it to this
|
||||
value. Default is `0` (auto).
|
||||
|
||||
**Widget width:** Disable automatic widget width definition and set it to this value. Default is `0` (auto).
|
||||
**Widget width:** Disable automatic widget width definition and set it to this
|
||||
value. Default is `0` (auto).
|
||||
|
||||
**Update interval:** Widget update interval. Default is `1000`.
|
||||
|
||||
**Queue limit:** Use thread pool with this maximum thread counts. `0` means CPU ideal thread count. Default is `0`.
|
||||
**Queue limit:** Use thread pool with this maximum thread counts. `0` means CPU
|
||||
ideal thread count. Default is `0`.
|
||||
|
||||
**Temperature units:** Select units for temperature. Available units are Celsius, Farenheit, Kelvin, Reaumur, cm^-1, kJ/mol, kcal/mol.
|
||||
**Temperature units:** Select units for temperature. Available units are Celsius,
|
||||
Farenheit, Kelvin, Reaumur, cm^-1, kJ/mol, kcal/mol.
|
||||
|
||||
**Custom time format:**
|
||||
|
||||
@ -337,48 +363,63 @@ Thus this feature may be used for example to show any custom values which will b
|
||||
|
||||
#### <a href="#tooltips" class="anchor" id="tooltips"><span class="octicon octicon-link"></span></a>Tooltips
|
||||
|
||||
Since version 1.7.0 CPU, CPU clock, memory, swap, network and battery support graphical tooltip. To enable them just select required fields. The number of stored values can be set in the tab. Colours of the graphs are configurable too.
|
||||
Since version 1.7.0 CPU, CPU clock, memory, swap, network and battery support
|
||||
graphical tooltip. To enable them just select required fields. The number of
|
||||
stored values can be set in the tab. Colours of the graphs are configurable too.
|
||||
|
||||
#### <a href="#deguiconf" class="anchor" id="deguiconf"><span class="octicon octicon-link"></span></a>DataEngine settings
|
||||
|
||||
**ACPI path:** Path to ACPI devices. The file `/sys/class/power_supply/`.
|
||||
|
||||
**GPU device:** Select one of supported GPU devices. `auto` will enable auto selection, `disable` will disable all GPU monitors. Default is `auto`.
|
||||
**GPU device:** Select one of supported GPU devices. `auto` will enable auto
|
||||
selection, `disable` will disable all GPU monitors. Default is `auto`.
|
||||
|
||||
**HDD:** Select one of HDDs for HDD temperature monitor. `all` will enable monitor for all devices, `disable` will disable HDD temperature monitor. Default is `all`.
|
||||
**HDD:** Select one of HDDs for HDD temperature monitor. `all` will enable
|
||||
monitor for all devices, `disable` will disable HDD temperature monitor. Default
|
||||
is `all`.
|
||||
|
||||
**hddtemp cmd:** Type a command which will be run for hddtemp DataEngine. Default is `sudo smartctl -a`.
|
||||
**hddtemp cmd:** Type a command which will be run for hddtemp DataEngine. Default
|
||||
is `sudo smartctl -a`.
|
||||
|
||||
**Player symbol count:** Symbol count for dynamic player tags.
|
||||
|
||||
**Music player:** Select one of supported music players for player label.
|
||||
|
||||
**MPRIS:** Select MPRIS player name. `auto` will enable auto selection. Default is `auto`.
|
||||
**MPRIS:** Select MPRIS player name. `auto` will enable auto selection. Default
|
||||
is `auto`.
|
||||
|
||||
**MPD address:** Address of MPD server. Default is `localhost`.
|
||||
|
||||
**MPD port:** Port of MPD server. Default is `6600`.
|
||||
|
||||
### <a href="#desktoppanel" class="anchor" id="desktoppanel"><span class="octicon octicon-link"></span></a>Desktop Panel
|
||||
Since version 1.11.0 it provides a minimalistic panel for monitoring on desktops. And yes, it looks like the same panel in Awesome.
|
||||
|
||||
Since version 1.11.0 it provides a minimalistic panel for monitoring on desktops.
|
||||
And yes, it looks like the same panel in Awesome.
|
||||
|
||||
##### <a href="#dpconf" class="anchor" id="dpconf"><span class="octicon octicon-link"></span></a>Desktop panel configuration
|
||||
|
||||
**Enable background:** Uncheck to disable default background and set transparent one. Default is `true`.
|
||||
**Enable background:** Uncheck to disable default background and set transparent
|
||||
one. Default is `true`.
|
||||
|
||||
**Vertical layout:** Use vertical layout instead of horizontal one. Default is `false`.
|
||||
**Vertical layout:** Use vertical layout instead of horizontal one. Default is
|
||||
`false`.
|
||||
|
||||
**Widget height:** Disable automatic widget height definition and set it to this value. Default is `0` (auto).
|
||||
**Widget height:** Disable automatic widget height definition and set it to this
|
||||
value. Default is `0` (auto).
|
||||
|
||||
**Widget width:** Disable automatic widget width definition and set it to this value. Default is `0` (auto).
|
||||
**Widget width:** Disable automatic widget width definition and set it to this
|
||||
value. Default is `0` (auto).
|
||||
|
||||
**Mark:** Type symbol (or string) which will be shown if this desktop is active now.
|
||||
**Mark:** Type symbol (or string) which will be shown if this desktop is active
|
||||
now.
|
||||
|
||||
**Tooltip type:** Select tooltip type. Default is `windows`.
|
||||
|
||||
**Tooltip width:** Using tooltip width in px. Default is `200px`.
|
||||
|
||||
**Color of tooltip:** Colour which is used in some tooltip types. Default is `#ffffff`.
|
||||
**Color of tooltip:** Colour which is used in some tooltip types. Default is
|
||||
`#ffffff`.
|
||||
|
||||
**Pattern tags**
|
||||
|
||||
|
@ -16,7 +16,10 @@ links:
|
||||
---
|
||||
<!-- info block -->
|
||||
|
||||
Plasmoid written on `CPP` that displays a random draw from Brian Eno and Peter Schmidt's [Oblique Strategies](//en.wikipedia.org/wiki/Oblique_strategies "Wiki"). It is [GNOME applet](//gnome-look.org/content/show.php/Oblique+Strategies?content=78405 "gnome-look") fork with some of special features.
|
||||
Plasmoid written on `CPP` that displays a random draw from Brian Eno and Peter
|
||||
Schmidt's [Oblique Strategies](//en.wikipedia.org/wiki/Oblique_strategies "Wiki").
|
||||
It is [GNOME applet](//gnome-look.org/content/show.php/Oblique+Strategies?content=78405
|
||||
"gnome-look") fork with some of special features.
|
||||
|
||||
<!--more-->
|
||||
|
||||
@ -36,7 +39,8 @@ Plasmoid written on `CPP` that displays a random draw from Brian Eno and Peter S
|
||||
|
||||
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Instruction
|
||||
|
||||
* Download an [archive](//github.com/arcan1s/oblikuestrategies/releases "GitHub") with latest version of source files.
|
||||
* Download an [archive](//github.com/arcan1s/oblikuestrategies/releases "GitHub")
|
||||
with latest version of source files.
|
||||
* Extract it and install the application. For global isntallation type:
|
||||
|
||||
```bash
|
||||
@ -63,7 +67,8 @@ Plasmoid written on `CPP` that displays a random draw from Brian Eno and Peter S
|
||||
kquitapp plasma-desktop && sleep 2 && plasma-desktop
|
||||
```
|
||||
|
||||
Also you might need to run `kbuildsycoca4` in order to get the `*.desktop` file recognized:
|
||||
Also you might need to run `kbuildsycoca4` in order to get the `*.desktop`
|
||||
file recognized:
|
||||
|
||||
```bash
|
||||
kbuildsycoca4 &> /dev/null
|
||||
|
@ -14,7 +14,8 @@ links:
|
||||
---
|
||||
<!-- info block -->
|
||||
|
||||
Daemon for starting jobs to queue of calculations. It was written as proof-of-concept.
|
||||
Daemon for starting jobs to queue of calculations. It was written as
|
||||
proof-of-concept.
|
||||
|
||||
<!--more-->
|
||||
|
||||
@ -57,7 +58,8 @@ Parameters:
|
||||
|
||||
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Instruction
|
||||
|
||||
* Download an [archive](//github.com/arcan1s/queued/releases "GitHub") with latest version of source files.
|
||||
* Download an [archive](//github.com/arcan1s/queued/releases "GitHub") with
|
||||
latest version of source files.
|
||||
* Extract it and install the application:
|
||||
|
||||
```bash
|
||||
@ -96,7 +98,8 @@ If you want to enable daemon autoload run
|
||||
systemctl enable queued
|
||||
```
|
||||
|
||||
But you may change path to configuration file or change parameters. To do it just copy (recommended) the source configuration file to new path
|
||||
But you may change path to configuration file or change parameters. To do it
|
||||
just copy (recommended) the source configuration file to new path
|
||||
|
||||
```bash
|
||||
cp /etc/queued.conf /path/to/new/queued.conf
|
||||
@ -131,7 +134,8 @@ Also you may use `add_queued`.
|
||||
|
||||
## <a href="#configuration" class="anchor" id="configuration"><span class="octicon octicon-link"></span></a>Configuration
|
||||
|
||||
All settings are stored in `/etc/queued.conf`. After edit them you must restart daemon
|
||||
All settings are stored in `/etc/queued.conf`. After edit them you must restart
|
||||
daemon
|
||||
|
||||
```bash
|
||||
systemctl restart queued
|
||||
|
@ -20,11 +20,16 @@ links:
|
||||
---
|
||||
<!-- info block -->
|
||||
|
||||
Graphical interface for `netctl` (several scripts for work with network connection in Archlinux). It is written on `C++` using `Qt` library. Now it may work with profiles and may create new profiles. Also it may create a connection to WiFi. Moreover, it provides a Qt library for interaction with netctl and widget and DataEngine for KDE4/KF5.
|
||||
Graphical interface for `netctl` (several scripts for work with network connection
|
||||
in Archlinux). It is written on `C++` using `Qt` library. Now it may work with
|
||||
profiles and may create new profiles. Also it may create a connection to WiFi.
|
||||
Moreover, it provides a Qt library for interaction with netctl and widget and
|
||||
DataEngine for KDE4/KF5.
|
||||
|
||||
<!--more-->
|
||||
|
||||
**NOTE:** [LOOKING FOR TRANSLATORS!](//github.com/arcan1s/netctl-gui/issues/3 "Ticket")
|
||||
**NOTE:** [LOOKING FOR TRANSLATORS!](//github.com/arcan1s/netctl-gui/issues/3
|
||||
"Ticket")
|
||||
|
||||
```bash
|
||||
$ netctl-gui --help
|
||||
@ -91,8 +96,10 @@ Options:
|
||||
|
||||
### <a href="#instruction" class="anchor" id="instruction"><span class="octicon octicon-link"></span></a>Instruction
|
||||
|
||||
* Download an [archive](//github.com/arcan1s/netctl-gui/releases "GitHub") with latest version of source files.
|
||||
* Extract it and install the application. If you want install it into `/`, you should run as root following commands:
|
||||
* Download an [archive](//github.com/arcan1s/netctl-gui/releases "GitHub") with
|
||||
latest version of source files.
|
||||
* Extract it and install the application. If you want install it into `/`, you
|
||||
should run as root following commands:
|
||||
|
||||
```bash
|
||||
cd /path/to/extracted/archive
|
||||
@ -139,21 +146,25 @@ I want note that all were tested on latest version of dependencies.
|
||||
<!-- howto block -->
|
||||
## <a href="#howto" class="anchor" id="howto"><span class="octicon octicon-link"></span></a>How to use
|
||||
|
||||
Just run application `netctl-gui`. If it is needed (and if you use KDE), you may add widget `netctl`, which provides by the application.
|
||||
Just run application `netctl-gui`. If it is needed (and if you use KDE), you may
|
||||
add widget `netctl`, which provides by the application.
|
||||
|
||||
<!-- end of howto block -->
|
||||
|
||||
<!-- config block -->
|
||||
## <a href="#config" class="anchor" id="config"><span class="octicon octicon-link"></span></a>Configuration
|
||||
|
||||
It is recommended to use graphical interface for configuration. Configuration files are:
|
||||
It is recommended to use graphical interface for configuration. Configuration
|
||||
files are:
|
||||
|
||||
* UI and helper
|
||||
* `$HOME/.config/netctl-gui.conf` - GUI/helper user configuration
|
||||
* `/etc/netctl-gui.conf` - helper system-wide configuration
|
||||
* DataEngine (KDE4 version)
|
||||
* `$KDEHOME/share/config/plasma-dataengine-netctl.conf` - DataEngine user configuration
|
||||
* `$KDESYSTEM/share/config/plasma-dataengine-netctl.conf` - DataEngine system-wide configuration
|
||||
* `$KDEHOME/share/config/plasma-dataengine-netctl.conf` - DataEngine user
|
||||
configuration
|
||||
* `$KDESYSTEM/share/config/plasma-dataengine-netctl.conf` - DataEngine
|
||||
system-wide configuration
|
||||
* DataEngine (KF5 version)
|
||||
* `$HOME/.config/plasma-dataengine-netctl.conf` - DataEngine user configuration
|
||||
* `/etc/xdg/plasma-dataengine-netctl.conf` - DataEngine system-wide configuration
|
||||
|
@ -14,7 +14,10 @@ links:
|
||||
---
|
||||
<!-- info block -->
|
||||
|
||||
Qt application/library which allows users to create an issue for projects which are hosted on GitHub. It may work over [GitHub](//github.com "GitHub") or [GitReport](//gitreports.com/ "GitReports"). It works fine, but it was created as proof-of-concept.
|
||||
Qt application/library which allows users to create an issue for projects which
|
||||
are hosted on GitHub. It may work over [GitHub](//github.com "GitHub") or
|
||||
[GitReport](//gitreports.com/ "GitReports"). It works fine, but it was created
|
||||
as proof-of-concept.
|
||||
|
||||
<!--more-->
|
||||
|
||||
@ -36,7 +39,8 @@ Qt application/library which allows users to create an issue for projects which
|
||||
|
||||
#### <a href="#singleapp" class="anchor" id="singleapp"><span class="octicon octicon-link"></span></a>Build as a standalone application
|
||||
|
||||
* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases "GitHub").
|
||||
* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases
|
||||
"GitHub").
|
||||
* Extract it and set up your configuration.
|
||||
* Install the application:
|
||||
|
||||
@ -50,7 +54,8 @@ Qt application/library which allows users to create an issue for projects which
|
||||
|
||||
#### <a href="#aslibrary" class="anchor" id="aslibrary"><span class="octicon octicon-link"></span></a>Build as a library in your project
|
||||
|
||||
* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases "GitHub").
|
||||
* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases
|
||||
"GitHub").
|
||||
* Extract it and set up your configuration.
|
||||
* include it into your project. For example if you use `cmake`:
|
||||
|
||||
@ -86,7 +91,8 @@ I want note that all were tested on latest version of dependencies.
|
||||
* automoc4 *(make)*
|
||||
* cmake *(make)*
|
||||
* doxygen *(make, documentation)*
|
||||
* qt5-webkit (if Qt5 is used) **or** qtwebkit (if Qt4 is used) *(optional, required by GitReports module)*
|
||||
* qt5-webkit (if Qt5 is used) **or** qtwebkit (if Qt4 is used) *(optional,
|
||||
required by GitReports module)*
|
||||
|
||||
<!-- end of install block -->
|
||||
|
||||
@ -95,7 +101,9 @@ I want note that all were tested on latest version of dependencies.
|
||||
|
||||
### <a href="#github" class="anchor" id="github"><span class="octicon octicon-link"></span></a>GitHub module
|
||||
|
||||
This module creates an issue over GitHub. [GitHub API](//developer.github.com/v3/issues/ "Documentation") is used for creating issue. User should type own username and password. The typical POST request is:
|
||||
This module creates an issue over GitHub. [GitHub API](//developer.github.com/v3/issues/
|
||||
"Documentation") is used for creating issue. User should type own username and
|
||||
password. The typical POST request is:
|
||||
|
||||
```bash
|
||||
curl -X POST -u user:pass -d '{"title":"A new bug","body":"Some error occurs"}' \
|
||||
@ -104,7 +112,10 @@ curl -X POST -u user:pass -d '{"title":"A new bug","body":"Some error occurs"}'
|
||||
|
||||
To disable this module use `-DENABLE_GITHUB=0` cmake flag.
|
||||
|
||||
This module may send request using developer's token too. Please visit [this page](//github.com/settings/applications "Settings") and generate a new one. Needed scopes are `public_repo` (or `repo` if you will use it for a private repository).
|
||||
This module may send request using developer's token too. Please visit [this
|
||||
page](//github.com/settings/applications "Settings") and generate a new one.
|
||||
Needed scopes are `public_repo` (or `repo` if you will use it for a private
|
||||
repository).
|
||||
|
||||
**Please keep in mind that passing the token in the clear, you may discredit your account.**
|
||||
|
||||
@ -121,16 +132,21 @@ This module requires `QtNetwork` module.
|
||||
|
||||
### <a href="#gitreports" class="anchor" id="gitreports"><span class="octicon octicon-link"></span></a>GitReports module
|
||||
|
||||
This module creates issue over [GitReports](//gitreports.com/about "GitReports"). Please visit [this page](//gitreports.com/ "GitReports") and set up it for your repository.
|
||||
This module creates issue over [GitReports](//gitreports.com/about "GitReports").
|
||||
Please visit [this page](//gitreports.com/ "GitReports") and set up it for your
|
||||
repository.
|
||||
|
||||
To disable this module use `-DENABLE_GITREPORT=0` cmake flag. This module requires `QtNetwork` and `QtWebKit` modules.
|
||||
To disable this module use `-DENABLE_GITREPORT=0` cmake flag. This module requires
|
||||
`QtNetwork` and `QtWebKit` modules.
|
||||
|
||||
<!-- end of howto block -->
|
||||
|
||||
<!-- config block -->
|
||||
## <a href="#config" class="anchor" id="config"><span class="octicon octicon-link"></span></a>Configuration
|
||||
|
||||
For the developer configuration please use `config.h` header. Also you may load parametrs dynamically using `params` array (needed keys is the same as for the header
|
||||
For the developer configuration please use `config.h` header. Also you may load
|
||||
parametrs dynamically using `params` array (needed keys is the same as for the
|
||||
header
|
||||
|
||||
### <a href="#mainconfig" class="anchor" id="mainconfig"><span class="octicon octicon-link"></span></a>Main configuration
|
||||
|
||||
@ -138,20 +154,31 @@ For the developer configuration please use `config.h` header. Also you may load
|
||||
* `PROJECT` - the project name.
|
||||
* `TAG_BODY` - default body of an issue. It may be used for both modules.
|
||||
* `TAG_TITLE` - default title of an issue. It may be used only for GitHub module.
|
||||
* `TAG_ASSIGNEE` - assign an issue to this account. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
|
||||
* `TAG_LABELS` - set these labels to an issue. Labels should be comma separated. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
|
||||
* `TAG_MILESTONE` - set this milestone to an issue. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
|
||||
* `TAG_ASSIGNEE` - assign an issue to this account. It may be used only for
|
||||
GitHub module. This tag will work only if user has push access. If it will be
|
||||
empty, it will be ignored.
|
||||
* `TAG_LABELS` - set these labels to an issue. Labels should be comma separated.
|
||||
It may be used only for GitHub module. This tag will work only if user has push
|
||||
access. If it will be empty, it will be ignored.
|
||||
* `TAG_MILESTONE` - set this milestone to an issue. It may be used only for
|
||||
GitHub module. This tag will work only if user has push access. If it will be
|
||||
empty, it will be ignored.
|
||||
|
||||
### <a href="#githubconfig" class="anchor" id="githubconfig"><span class="octicon octicon-link"></span></a>GitHub module settings
|
||||
|
||||
* `GITHUB_COMBOBOX` - text of this module into comboBox.
|
||||
* `ISSUES_URL` - issues url, in the most cases do not touch it. Default is `//api.github.com/repos/$OWNER/$PROJECT/issues`. Available tags here are `$PROJECT`, `$OWNER`.
|
||||
* `ISSUES_URL` - issues url, in the most cases do not touch it. Default is
|
||||
`//api.github.com/repos/$OWNER/$PROJECT/issues`. Available tags here are
|
||||
`$PROJECT`, `$OWNER`.
|
||||
|
||||
### <a href="#gitreportsconfig" class="anchor" id="gitreportsconfig"><span class="octicon octicon-link"></span></a>GitReports module settings
|
||||
|
||||
* `CAPTCHA_URL` - captcha url, in the most cases do not touch it. Default is `//gitreports.com/simple_captcha?code=`.
|
||||
* `CAPTCHA_URL` - captcha url, in the most cases do not touch it. Default is
|
||||
`//gitreports.com/simple_captcha?code=`.
|
||||
* `GITREPORT_COMBOBOX` - text of this module into comboBox.
|
||||
* `PUBLIC_URL` - issues url, in the most cases do not touch it. Default is `//gitreports.com/issue/$OWNER/$PROJECT`. Available tags here are `$PROJECT`, `$OWNER`.
|
||||
* `PUBLIC_URL` - issues url, in the most cases do not touch it. Default is
|
||||
`//gitreports.com/issue/$OWNER/$PROJECT`. Available tags here are `$PROJECT`,
|
||||
`$OWNER`.
|
||||
|
||||
<!-- end of config block -->
|
||||
|
||||
|
Reference in New Issue
Block a user