From 717c3d4bf5abe0fd689f778994aa31f488b38fc8 Mon Sep 17 00:00:00 2001 From: Pekka Vuorela Date: Mon, 6 Nov 2023 17:18:05 +0200 Subject: [PATCH] Switch README to .md format and streamline it - Talk about wayland homescreen instead of vague "user experiences". - Remove author list which hasn't been updated for people that have been really doing work the past decade. - Remove references to ancient lipstick-example-home, last touched 2012 and unlikely to work much these days. - Added some capitalizations. --- README | 54 ------------------------------------------------------ README.md | 20 ++++++++++++++++++++ 2 files changed, 20 insertions(+), 54 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 2775b7ab..00000000 --- a/README +++ /dev/null @@ -1,54 +0,0 @@ -lipstick -======== - -lipstick is a project aimed at offering easy to modify user experiences -for varying mobile device form factors, e.g. handsets, netbooks, tablets. - -User experiences are written in QML. - -acknowledgements -================ - -lipstick builds heavily on the work of the meegotouchhome and meego-ux-daemon -authors. Thanks. - -Thanks also to Nokia and Intel for opening this work, and thanks to Jolla for -continuing to work on it, in the open. - -authors -======= - -lipstick contains work from many, many folks. here's a particular special few. - -Robin Burchell - initial prototyping, naming, occasional hackery -Timur Kristof - the UX/library split, initial work on a pretty UX -Tom Swindell - initial work on a pretty UX -Vesa Halttunen - various functionality additions, guidance, working it towards a product -Aaron Kennedy - work on Wayland port -Mikko Harju - work on Wayland issues/port - -... and many others. If you feel like you belong here, you probably do. Submit a -pull request. - -building / dependencies -======================= - -check the specfile in the 'rpm' directory. or just use mb2 to build. - -how to run lipstick -=================== - -1. Build lipstick. -2. Install lipstick. -3. Get yourself a desktop - If you haven't got anything better to use, grab the example - (http://github.com/nemomobile/lipstick-example-home/). - - Build according to instructions, and run it. - - Desktops use both the plugin and shared library generally, so - both of them should be intact before you can run the example - - NOTE: if you use a properly packaged version of the library, - you won't need to go through this trouble - diff --git a/README.md b/README.md new file mode 100644 index 00000000..52440a9e --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +Lipstick +======== + +Lipstick is a framework for building (mostly Wayland) homescreen applications for +mobile devices. It's based on Qt and QML. + +Acknowledgements +================ + +Lipstick builds heavily on the work of the meegotouchhome and meego-ux-daemon +authors. Thanks. + +Thanks also to Nokia and Intel for opening this work, and thanks to Jolla for +continuing to work on it, in the open. + +Building / dependencies +======================= + +Check the specfile in the 'rpm' directory. Or just use mb2 to build. +