Skip to content

Commit baabef8

Browse files
committed
chore: Update the README
1 parent dcd60f6 commit baabef8

File tree

1 file changed

+13
-34
lines changed

1 file changed

+13
-34
lines changed

README.md

Lines changed: 13 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -19,49 +19,28 @@ Brought to you by the [Papyros development team](https://github.com/papyros/qml-
1919
* CMake
2020
* [Extra CMake Modules](http://api.kde.org/ecm/manual/ecm.7.html)
2121

22-
### System-wide installation
23-
24-
From the root of the repository, run:
25-
26-
$ mkdir build; cd build
27-
$ cmake .. # Add any additional args here as necessary for your platform
28-
$ make
29-
$ ctest -V # Optional, make sure everything is working correctly
30-
$ sudo make install
22+
### Per-project installation using QPM
3123

32-
Now check out the `demo` folder to see how to use Material Design from QtQuick!
24+
QPM package coming soon!
3325

34-
### Material.Extras
26+
Just install using:
3527

36-
The material framework comes with a collection of useful non-UI-related extras in the `Material.Extras` module. This includes a Promises library, date and list utility functions, and an HTTP library based on Promises. Here are some examples of what you can do with these additional components:
28+
qpm install io.papyros.material
3729

38-
Promise:
30+
If you want to bundle the Roboto fonts in your project, file **ABOVE** the `include(vendor/vendor.pri)` line, add the following line:
3931

40-
```qml
41-
import QtQuick 2.3
42-
import Material.Extras 0.1
32+
OPTIONS += roboto
4333

44-
Item {
45-
function makePromise() {
46-
var myvalue = "";
34+
### System-wide installation
4735

48-
var promise = new Promises.Promse();
49-
promise.info.myinfo = "cool info";
50-
promise.then(function( data, info ) {
51-
// send data to the next step
52-
return info.myinfo + " " + data;
53-
});
36+
From the root of the repository, run:
5437

55-
promise.done(function( data, info ) {
56-
// do something with the data of resolve(...)
57-
});
38+
mkdir build; cd build
39+
qmake ..
40+
make
41+
make install # use sudo if necessary
5842

59-
promise.error(function( error, info ) {
60-
// do something with the data of reject(...)
61-
});
62-
}
63-
}
64-
```
43+
Now check out the `demo` folder to see how to use Material Design from QtQuick!
6544

6645
### Licensing
6746

0 commit comments

Comments
 (0)