lokinet-control-panel/README.md

# Lokinet Control Panel

![Screenshot](../media/images/lokinet_ui_screenshot.png?raw=true)

This repository contains a cross-platform GUI for controlling and observing stats from a locally-running `lokinet`. See also [loki-network](https://github.com/loki-project/loki-network).

### Building

To build, you'll need a handful of `Qt` packages available. On `Ubuntu` or similar, you can install these with:

```bash
sudo apt install qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtquick-controls2 qml-module-qtquick-dialogs qml-module-qt-labs-platform qml-module-qtcharts libqt5charts5-dev
```

Then build and run:

```bash
mkdir build
cd build
qmake ../lokicp.pro "CONFIG+=debug"
make
./lokicp
```

### Usage

The app starts running in the background with access available through the system tray. Click on the system tray icon to interact with the app.

### Status

This app is under heavy development. While the basic layout of the UI is established, the data is currently hard-coded.
Initial commit: brief README.md, 'hello world' QT/QML app 2019-10-03 23:31:01 +02:00			`# Lokinet Control Panel`

Update README.md - add screenshot and brief usage/status descriptions 2019-10-06 17:58:10 +02:00			`![Screenshot](../media/images/lokinet_ui_screenshot.png?raw=true)`

Initial commit: brief README.md, 'hello world' QT/QML app 2019-10-03 23:31:01 +02:00			This repository contains a cross-platform GUI for controlling and observing stats from a locally-running `lokinet`. See also [loki-network](https://github.com/loki-project/loki-network).

			`### Building`

			To build, you'll need a handful of `Qt` packages available. On `Ubuntu` or similar, you can install these with:

			```bash
Append 'libqt5charts5-dev' to 'apt install' list 2020-02-10 20:43:26 +01:00			`sudo apt install qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtquick-controls2 qml-module-qtquick-dialogs qml-module-qt-labs-platform qml-module-qtcharts libqt5charts5-dev`
Initial commit: brief README.md, 'hello world' QT/QML app 2019-10-03 23:31:01 +02:00			```

			`Then build and run:`

			```bash
Clean up directory structure, provide out-of-source[-ish] build instructions 2019-10-04 17:41:57 +02:00			`mkdir build`
			`cd build`
			`qmake ../lokicp.pro "CONFIG+=debug"`
Initial commit: brief README.md, 'hello world' QT/QML app 2019-10-03 23:31:01 +02:00			`make`
			`./lokicp`
			```
Update README.md - add screenshot and brief usage/status descriptions 2019-10-06 17:58:10 +02:00
			`### Usage`

			`The app starts running in the background with access available through the system tray. Click on the system tray icon to interact with the app.`

			`### Status`

			`This app is under heavy development. While the basic layout of the UI is established, the data is currently hard-coded.`