Skip to content

Commit 17eb01e

Browse files
committed
Update README.md
1 parent ce11369 commit 17eb01e

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

README.md

+19-13
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
11
# Liri Text
22
This is Liri Text, crossplatform text editor made in accordance with Material Design.
3-
For now it only provides very basic functionality, but will evolve into a very powerfull tool with a lot of advanced features some time...
3+
For now it only provides very basic functionality, but will evolve into a very powerful tool some time.
44

55
## Installation
6-
We'll be providing prebuilt binaries soon, but currently you can only try Liri Text by building it from source
6+
You may find a prebuilt binary for your platform on [releases page](https://github.com/liri-project/liri-text/releases).
7+
If your platform is not yet supported or you wish to contribute to this project's development, you can compile Liri Text from source following the instructions below:
78

8-
### Install dependencies
9-
- [Qt 5.5 or higher](http://qt.io)
10-
- [qml-material](https://github.com/papyros/qml-material)
9+
## Build
10+
1. Install dependencies
11+
- [Qt 5.5 or higher](http://qt.io)
1112

12-
### Build and run Liri Text
13-
```
14-
git clone https://github.com/liri-project/liri-text.git
15-
cd liri-text
16-
qmake
17-
make
18-
```
19-
This will produce `liri-text` binary
13+
2. Build Liri Text
14+
```
15+
git clone --recursive https://github.com/liri-project/liri-text.git
16+
cd liri-text
17+
mkdir build; cd build
18+
qmake ..
19+
make
20+
```
21+
22+
3. Optionally install
23+
```
24+
sudo make install
25+
```
2026

2127
## License
2228
This application 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.

0 commit comments

Comments
 (0)