Commit 1370399e authored by Han Young's avatar Han Young
Browse files

update README

parent ede1f727
Kalk
====
Kalk is a powerful cross-platfrom calculator application built with the [Kirigami framework](https://kde.org/products/kirigami/).
### Kalk is a calculator application built with the [Kirigami framework](https://kde.org/products/kirigami/). Though mainly targeted to mobile platform, the UI/UX is also smooth on desktop.
Kalk is targeted towards the use with Plasma Mobile, but can also be used on desktop platforms.
Kalk is in a very early stage of development and very work in progress. See issue in gitlab for things to be done.
Kalk is a fork of [Liri calculator](https://github.com/lirios/calculator)
### Starting as a fork of [Liri calculator](https://github.com/lirios/calculator), Kalk went through heavy development, and we current share no code with Liri calculator.
### features
* basic calculation
* history
* unit conversion
* currency coversion
## Dependencies
Qt5, Cmake, KI18n, KUnitConversion, Kirigami, KConfig, GNU Bison, Flex
* Qt5
* Cmake
* KI18n
* KUnitConversion
* Kirigami
* KConfig
* GNU Bison
* Flex
## Build, Install
```sh
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/path/to/prefix -G Ninja..
cmake -DCMAKE_INSTALL_PREFIX=/path/to/prefix -G Ninja ..
ninja install # use sudo if necessary
```
......@@ -24,6 +32,16 @@ Replace `/path/to/prefix` to your installation prefix.
Default is `/usr/local`.
## Licensing
Kalk is a fork of [Liri calculator](https://github.com/lirios/calculator). This branch was forked from [cahfofpai's fork](https://invent.kde.org/cahfofpai/kalk)
I don't know how to licensing this.
### GPL 3
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment