Codebase list sugar-log-activity / 14fa6f1
Rewrite README.md * how to use, * how to integrate, * how to develop, * APIs, * branches. James Cameron 4 years ago
1 changed file(s) with 70 addition(s) and 1 deletion(s). Raw diff Collapse all Expand all
+70
-1
README.md less more
55 How to use?
66 ===========
77
8 Log is part of the Sugar desktop. Please refer to;
8 Log is part of the Sugar desktop.
9
10 Log is used when looking for why an activity or Sugar is not working properly.
11
12 For an activity, start the activity, make the activity do something wrong, then stop the activity. Check that the activity is stopped by opening the Frame (F6). Start the Log activity (F3, log, enter). Click on the log file for the activity; it will be named according to the activity bundle_id. Compare the log against what used to happen, or what happens when the activity does not do something wrong. Write to the maintainer of the activity or create an issue on GitHub in the activity repository. Explain how you made the activity do something wrong. Include the log as quoted text. Include the activity version.
13
14 For Sugar, make Sugar do something wrong, then stop Sugar by logging out. Log back in. Start the Log activity (F3, log, enter). Click on the date and time for when you logged out. Click on the `shell.log` or `datastore.log` files. Compare the log against what used to happen, or what happens when Sugar does not do something wrong. Write to the Sugar mailing list or create an issue on GitHub in the [sugar repository](https://github.com/sugarlabs/sugar). Explain how you made Sugar do something wrong. Include the log as quoted text. Include the Sugar version.
15
16 Please refer to;
917
1018 * [How to Get Sugar on sugarlabs.org](https://sugarlabs.org/),
1119 * [How to use Sugar](https://help.sugarlabs.org/),
1220 * [How to use Log](https://help.sugarlabs.org/log.html).
21
22 How to integrate?
23 =================
24
25 On Debian and Ubuntu systems;
26
27 ```
28 apt install sugar-log-activity
29 ```
30
31 On Fedora systems;
32
33 ```
34 dnf install sugar-log
35 ```
36
37 Log depends on Python, [Sugar
38 Toolkit](https://github.com/sugarlabs/sugar-toolkit-gtk3), D-Bus,
39 GTK+ 3, Pango, Python urllib. Log also runs several Linux utilities; ifconfig, route, df, ps, free, and top.
40
41 Log is started by [Sugar](https://github.com/sugarlabs/sugar).
42
43 Log is packaged by Linux distributions;
44 * [Debian package sugar-log-activity](https://packages.debian.org/sugar-log-activity),
45 * [Ubuntu package sugar-log-activity](https://packages.ubuntu.com/sugar-log-activity), and;
46 * [Fedora package sugar-log](https://src.fedoraproject.org/).
47
48 How to develop?
49 ===============
50
51 * setup a development environment for Sugar desktop,
52 * clone this repository,
53 * edit source files,
54 * test in Terminal by typing `sugar-activity3`
55
56 APIs
57 ====
58
59 Code inside Log depends on several APIs, including;
60
61 * [PyGObject](https://lazka.github.io/pgi-docs/), and;
62 * [Sugar Toolkit](https://developer.sugarlabs.org/sugar3).
63
64 Branch master
65 =============
66
67 The `master` branch targets an environment with latest stable release
68 of [Sugar](https://github.com/sugarlabs/sugar), with dependencies on
69 latest stable release of Fedora and Debian distributions.
70
71 Release tags are v41 and higher.
72
73 Branch python2
74 ==============
75
76 The `python2` branch is a backport of features and bug fixes from the
77 `master` branch for ongoing maintenance of the activity on Fedora 18,
78 Ubuntu 16.04 and Ubuntu 18.04 systems which don't have a Python 3
79 capable release of Sugar.
80
81 Release tags are v40.1 and higher, but lower than v41.