User:Inkyfingers/Testing Sweets: Difference between revisions

(19 intermediate revisions by 2 users not shown)

Line 1:

{{Under construction|~~This page may be incomprehensible~~ for ~~48 hours~~. --[[User:Inkyfingers|Inkyfingers]] 15:51, 19 December 2011 (EST)}}

{{Under construction|Ready for feedback!.--[[User:Inkyfingers|Inkyfingers]] 02:35, 20 December 2011 (EST)}}

Mint-12 successful install notes here: [[Talk:Platform Team/Guide/Sugar via Sweets#Installing Sugar via sweets - in Mint-12]]

==Mint-12 successful install==

==try this==

notes here: [[Talk:Platform Team/Guide/Sugar via Sweets#Installing Sugar via sweets - in Mint-12]]

===try this===

:http://wiki.sugarlabs.org/go/Community/Distributions/Sweets_Distribution

:works fine for 11.04 Linux Mint 11 I did this and it worked but alsroot wanted me to not put it on the wiki. It installs sweets-sugar 0.94.1 [[User:Satellit]] 9 Dec 2011

::Link: [[Talk:Platform_Team/Guide/Sugar_via_Sweets#Installing_sweets-sugar_from_Fedora_16_GNOME_3_Terminal|Installing_sweets-sugar_from_Fedora_16_GNOME_3_Terminal]]

:http://wiki.sugarlabs.org/go/Sugar_Creation_Kit/sck/Advanced_Topics#Sweets

== Exploring extra documentation ==

~~I propose to paste below:~~ [[~~Platform_Team~~/Guide/~~Sweets_Usage~~]]] ...

Expanding central section of [[Platform Team/Guide/Sweets Usage]]] ...

~~Then I cut the introduction and first paragraph.~~ What are the opportunities of improving documentation for users at a certain point, after install and before successful launch?

=== Aim of this paper ===

'''What are the opportunities of improving documentation for users at a certain point, after install and before successful launch?'''

=== Install ===

Imagine you are now reading [[Sweets/Getting started]]

Pre-introductory paragraphs explain what an emulator will look like, and the reasons for experimenting with it.

Introductory paragraph will have "fully" covered distro-non-specific apt-get update.

~~Enter in~~ the ~~Terminal activity, or any other terminal~~:

I suggest it might be a good idea to try to fix the level of experience expected of a reader. I suggest a potential reader would have some confidence at the level of http://en.flossmanuals.net/command-line/ch014_multiple-files/ . Do others think a lower level is reasonable? - define.

~~wget http://~~download~~.sugarlabs.org/sweets/sweets/~~installer.sh

Then "packagekit" and issues, then download and run script "installer.sh"

~~sh installer~~.sh

Then, "After installing PackageKit, you need to restart the DBus system bus," "Relogin from X session," or "Restart the machine"

: Minor issue 1. a) "Restart the machine" seems clumsy. b) I guess distro-non-specific instructions may be too difficult? It might be nice to include, say, the best available outside tutorial, even if only to demonstrate good practice?

~~Relogin~~ from ~~X session to take into account~~ the ~~new PATH environment variable value~~.

''Alternatively, {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]].''

~~Alternatively, {{Code|sweets}} might be run from~~ the ~~[[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]].~~

:Issue 2. This idea needs dealing with at an appropriate level. Is this an alternative for our reader? Under what conditions would the reader start on this method?

=== Upgrade ===

Line 27:

Line 38:

sweets upgrade

You should expect a positive response. An example of a positive response is

-- No need in upgrading

or

insert wording generated by successful upgrade.

If you run into difficulties, sweets contains a --help file. You get it with the command:

sweets -h

The file is displayed in your terminal, you get out of the file by pressing "q" for quit.

'''What about a negative response to your initial {{code|sweets}} command?'''

An example of a negative response at this stage is:

sweets: command not found.

If you are in this situation - did you restart either {{code|dbus}} or the computer before you gave the first {{code|sweets}} command?

You could restart the computer. If you still get a negative response from

sweets upgrade

and

sweets -h

then you need to work through the instructions above this point again.

==== What Sugar to launch ====

There are two types of Sugars that are accessible via Sweets:

* {{Code|sdk/sugar}}, for pristine Sugar;

* {{Code|dextrose/sugar}}, for Sugar based on [[Dextrose]].

The terms we use are currently defined here: [[Platform_Team/Guide/Sweets_Usage#Search]] and [[Platform_Team/Sweets/Glossary]]

The '''name''' of one available {{code|sweet}} (alternate usage ''<SWEET>'' ) is sdk/sugar.

Another's '''name''' (alternate usage ''<SWEET>'') is dextrose/sugar.

<s>look at : [[Talk:Platform_Team/Guide/Sugar_via_Sweets#Notes_on_how_to_start_0.88_or_0.94| How to start 0.88 or 0.94 Sweets Sugar]]--[[User:Satellit|Satellit]] 15:42, 21 December 2011 (EST). Thanks, added in next paragraph.</s>

: These lines aim to draw attention a perceived difficulty in nomenclature. Improved wording welcome.

<s>Both Sugars can be used in the same way. This guide uses {{Code|dextrose/sugar}} ... and may use {{Code|sdk/sugar}}</s>

== Launch ==

To launch recent stable Sugar in emulator mode, type in Terminal activity or in any other terminal:

sweets dextrose/sugar:emulator

To explain:

: sweets - the command to run sweets

:: dextrose/sugar - the sweet you want

::: :emulator - a command for an emulator.

To make it possible to have additional dependencies involved, e.g., to run Browse activity, use {{Code|-S}} command-line argument:

sweets -S dextrose/sugar:emulator

To explain,

we add an option, -S ( = --force-suggested) to force, using suggested dependencies

Hopefully one of those commands opened Sugar for you.

If not, try

sweets sdk/sugar:emulator

or

sweets -S sdk/sugar:emulator

we can also add an option to the emulator, for example,

sweets sdk/sugar:emulator -f

will ask the emulator to open, full screen.

'''If you have Sugar running - Explore'''

=== If you have a negative response to all four commands above ===

So this is the point of this effort!

'''What can we conclude?'''

Go back, review #Upgrade above, If {{Code|sweets upgrade}} and {{Code|sweets -h}} were positive - sweets is installed, no?

What further commands or tools are available at this point?

One possibility, not all required packages are installed?

Referring to my own experience - [[Talk:Platform Team/Guide/Sugar via Sweets#Installation 2]] (which is considerably abbreviated!)

the command {{Code|sweets -R sdk/sugar:emulator}} invoked a massive download of packages - @alsroot what changed?

: Snip from IRC #sugar-newbies, [21:25] <alsroot> the sweet "base/x11-libs" had a bug that was found in mint

'''What would an experienced user do next?'''

I think it is worth discussing, and I am not sure about this, some investigatory commands gave misleading answers, I feel because the whole toolbox was not present.

Have I drawn the wrong conclusion?

A question regarding -R option. Would the -R option eg:

sweets -R sdk/sugar:emulator

be superfluous straight after {{code|sweets upgrade}}?

I am currently in the above described situation with Sweets on Debian Wheezy. What is suggested here, I will test there.

'''Alternatively''', {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]]. This I have tried - I am not sure it adds content if one is stuck at this point?

''' The material below this point has not been edited.'''

''' Please move this marker if you edit, thanks.'''

* Back to original "Usage" page content.

== Usage ==

Line 39:

Line 160:

=== Launch ===

~~== ''' The material below this point has not been edited.''' ==~~

~~''' Please move this marker if you edit, thanks.'''~~

To launch a ''sweet'' with verbatim passing of optional {{Code|ARGUMENTS}}:

@@ Line 1: / Line 1: @@
-{{Under construction|This page may be incomprehensible for 48 hours. --[[User:Inkyfingers|Inkyfingers]] 15:51, 19 December 2011 (EST)}}
+{{Under construction|Ready for feedback!.--[[User:Inkyfingers|Inkyfingers]] 02:35, 20 December 2011 (EST)}}
-Mint-12 successful install notes here: [[Talk:Platform Team/Guide/Sugar via Sweets#Installing Sugar via sweets - in Mint-12]]
+==Mint-12 successful install==
-==try this==
+notes here: [[Talk:Platform Team/Guide/Sugar via Sweets#Installing Sugar via sweets - in Mint-12]]
+===try this===
 :http://wiki.sugarlabs.org/go/Community/Distributions/Sweets_Distribution
 :works fine for 11.04 Linux Mint 11  I did this and it worked but alsroot wanted me to not put it on the wiki. It installs sweets-sugar 0.94.1 [[User:Satellit]] 9 Dec 2011
+::Link:  [[Talk:Platform_Team/Guide/Sugar_via_Sweets#Installing_sweets-sugar_from_Fedora_16_GNOME_3_Terminal|Installing_sweets-sugar_from_Fedora_16_GNOME_3_Terminal]]
+:http://wiki.sugarlabs.org/go/Sugar_Creation_Kit/sck/Advanced_Topics#Sweets
 == Exploring extra documentation ==
-I propose to paste below: [[Platform_Team/Guide/Sweets_Usage]]] ...
+Expanding central section of [[Platform Team/Guide/Sweets Usage]]] ...
-Then I cut the introduction and first paragraph. What are the opportunities of improving documentation for users at a certain point, after install and before successful launch?
+=== Aim of this paper ===
+'''What are the opportunities of improving documentation for users at a certain point, after install and before successful launch?'''
 === Install ===
+Imagine you are now reading [[Sweets/Getting started]]
+Pre-introductory paragraphs explain what an emulator will look like, and the reasons for experimenting with it.
+Introductory paragraph will have "fully" covered distro-non-specific apt-get update.
-Enter in the Terminal activity, or any other terminal:
+I suggest it might be a good idea to try to fix the level of experience expected of a reader. I suggest a potential reader would have some confidence at the  level of http://en.flossmanuals.net/command-line/ch014_multiple-files/ . Do others think a lower level is reasonable? - define.
- wget http://download.sugarlabs.org/sweets/sweets/installer.sh
+Then "packagekit" and issues, then download and run script "installer.sh"
-  sh installer.sh
+Then, "After installing PackageKit, you need to restart the DBus system bus,"  "Relogin from X session," or "Restart the machine"
+: Minor issue 1. a) "Restart the machine" seems clumsy. b) I guess distro-non-specific instructions  may be too difficult? It might be nice to include, say, the best available outside tutorial, even if only to demonstrate good practice?
-Relogin from X session to take into account the new PATH environment variable value.
+''Alternatively, {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]].''
-Alternatively, {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]].
+:Issue 2. This idea needs dealing with at an appropriate level. Is this an alternative for our reader? Under what conditions would the reader start on this method?
 === Upgrade ===
@@ Line 27: / Line 38: @@
   sweets upgrade
+You should expect a positive response. An example of a positive response is
+ -- No need in upgrading
+or
+ insert wording generated by successful upgrade.
+If you run into difficulties, sweets contains a --help file. You get it with the command:
+ sweets -h
+The file is displayed in your terminal, you get out of the file by pressing "q" for quit.
+'''What about a negative response to your initial {{code|sweets}} command?'''
+An example of a negative response at this stage is:
+ sweets: command not found.
+If you are in this situation - did you restart either {{code|dbus}} or the computer before you gave the first {{code|sweets}} command?
+You could restart the computer. If you still get a negative response from
+ sweets upgrade
+and
+ sweets -h
+then you need to work through the instructions above this point again.
+==== What Sugar to launch ====
+There are two types of Sugars that are accessible via Sweets:
+* {{Code|sdk/sugar}}, for pristine Sugar;
+* {{Code|dextrose/sugar}}, for Sugar based on [[Dextrose]].
+The terms we use are currently defined here: [[Platform_Team/Guide/Sweets_Usage#Search]] and [[Platform_Team/Sweets/Glossary]]
+The '''name''' of one available {{code|sweet}} (alternate usage ''<SWEET>'' ) is sdk/sugar.
+Another's '''name''' (alternate usage ''<SWEET>'') is dextrose/sugar.
+<s>look at :  [[Talk:Platform_Team/Guide/Sugar_via_Sweets#Notes_on_how_to_start_0.88_or_0.94| How to start 0.88 or 0.94 Sweets Sugar]]--[[User:Satellit|Satellit]] 15:42, 21 December 2011 (EST). Thanks, added in next paragraph.</s>
+: These lines aim to draw attention a perceived difficulty in nomenclature. Improved wording welcome.
+<s>Both Sugars can be used in the same way. This guide uses {{Code|dextrose/sugar}} ... and may use {{Code|sdk/sugar}}</s>
+== Launch ==
+To launch recent stable Sugar in emulator mode, type in Terminal activity or in any other terminal:
+ sweets dextrose/sugar:emulator
+To explain:
+: sweets - the command to run sweets
+:: dextrose/sugar - the sweet you want
+::: :emulator - a command for an emulator.
+To make it possible to have additional dependencies involved, e.g., to run Browse activity, use {{Code|-S}} command-line argument:
+ sweets -S dextrose/sugar:emulator
+To explain,
+we add an option, -S ( = --force-suggested) to force, using suggested dependencies
+Hopefully one of those commands opened Sugar for you.
+If not, try
+ sweets sdk/sugar:emulator
+or
+ sweets -S sdk/sugar:emulator
+we can also add an option to the emulator, for example,
+ sweets sdk/sugar:emulator -f
+will ask the emulator to open, full screen.
+'''If you have Sugar running - Explore'''
+=== If you have a negative response to all four commands above ===
+So this is the point of this effort!
+'''What can we conclude?'''
+Go back, review #Upgrade above, If {{Code|sweets upgrade}} and {{Code|sweets -h}} were positive - sweets is installed, no?
+What further commands or tools are available at this point?
+One possibility, not all required packages are installed?
+Referring to my own experience - [[Talk:Platform Team/Guide/Sugar via Sweets#Installation 2]] (which is considerably abbreviated!)
+the command {{Code|sweets -R sdk/sugar:emulator}} invoked a massive download of packages -  @alsroot what changed?
+: Snip from IRC #sugar-newbies, [21:25] <alsroot> the sweet "base/x11-libs" had a bug that was found in mint
+'''What would an experienced user do next?'''
+I think it is worth discussing, and I am not sure about this, some investigatory commands gave misleading answers, I feel because the whole toolbox was not present.
+Have I drawn the wrong conclusion?
+A question regarding -R option. Would the -R option eg:
+ sweets -R sdk/sugar:emulator
+be superfluous straight after {{code|sweets upgrade}}?
+I am currently in the above described situation with Sweets on Debian Wheezy. What is suggested here, I will test there.
+'''Alternatively''', {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]]. This I have tried - I am not sure it adds content if one is stuck at this point?
+''' The material below this point has not been edited.'''
+''' Please move this marker if you edit, thanks.'''
+* Back to original "Usage" page content.
 == Usage ==
@@ Line 39: / Line 160: @@
 === Launch ===
-== ''' The material below this point has not been edited.''' ==
-''' Please move this marker if you edit, thanks.'''
 To launch a ''sweet'' with verbatim passing of optional {{Code|ARGUMENTS}}: