From 73df533b060d3ed145cc9ddf8615e8921fee73ff Mon Sep 17 00:00:00 2001 From: James Cameron Date: Wed, 19 Jul 2017 12:38:43 +1000 Subject: [PATCH] README - add build and install --- README | 3 --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 3 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 0c5cbceb..00000000 --- a/README +++ /dev/null @@ -1,3 +0,0 @@ -Sugar is the core of the OLPC Human Interface. The toolkit provides -a set of widgets to build HIG compliant applications and interfaces -to interact with system services like presence and the datastore. diff --git a/README.md b/README.md new file mode 100644 index 00000000..c074e93c --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +Sugar Toolkit +============= + +Sugar Toolkit provides services and a set of GTK+ widgets to build +activities and other Sugar components on Linux based computers. + +This is the GTK+ 3 binding of the Sugar Toolkit. + +https://www.sugarlabs.org/ + +https://wiki.sugarlabs.org/ + +Installing on Debian or Ubuntu +------------------------------ + +Automatically done when you install [Sugar +desktop](https://github.com/sugarlabs/sugar). + +To install Sugar Toolkit alone without Sugar desktop, + +``` +sudo apt install python-sugar3 +``` + +Installing on Fedora +-------------------- + +Automatically done when you install [Sugar +desktop](https://github.com/sugarlabs/sugar). + +To install Sugar Toolkit alone without Sugar desktop, + +``` +sudo dnf install sugar-toolkit-gtk3 +``` + +Building +-------- + +Sugar Toolkit follows the [GNU Coding +Standards](https://www.gnu.org/prep/standards/). + +Install all dependencies, especially sugar-artwork and +sugar-datastore. + +Clone the repository, run `autogen.sh`, then `make` and `make +install`.