Activity Team/Sweetener: Difference between revisions

(6 intermediate revisions by 2 users not shown)

Line 2:

== Maintainers ==

*[[User:~~Daniel_Francis~~|Daniel Francis]]

*[[User:Francis|Daniel Francis]]

== Current Release ==

At the moment it hasn't got a stable release. Clone the [http://git.sugarlabs.org/sweetener GIT Repository] and feel free to send patches, request merges or contact the maintainers.

== Documentation ==

The Sweetener documentation is available in [http://people.sugarlabs.org/francis/sweetenerdoc].

Its source code is in Git:

http://git.sugarlabs.org/sweetener/doc

== Get started creating an activity==

* Start a repository on [http://git.sugarlabs.org/ Git]

* Clone Sweetener

git clone git://git.sugarlabs.org/sweetener/sweetener.git

$ git clone git://git.sugarlabs.org/sweetener/sweetener.git

* Copy to your new activity directory the following files:

Makefile

Line 16:

Line 23:

canvas.py

info.py

~~makescripts/~~

options.py

setup.py

Line 24:

Line 30:

* Make the following directories inside your activity:

activity/

sugar~~/sweetener~~/

sugar/

desktop~~/sweetener~~/ # (Only if you want to run your activity on Linux desktops)

desktop/ # (Only if you want to run your activity on Linux desktops)

* ~~Copy basic modules~~:~~<br> Sweetener is divided in modules, for a very basic activity, you'll need to copy to (sugar - desktop)~~/~~sweetener:~~

* Clone sweetener submodules

~~__init__~~.py

$ git submodule add git://git.sugarlabs.org/sweetener/makescripts

~~basic_options~~.py

$ git submodule add git://git.sugarlabs.org/sweetener/sugar sugar/sweetener

~~item~~.py

~~itembox~~.py

# This is only for other Linux desktops.

~~stock.py~~

$ git submodule add git://git.sugarlabs.org/sweetener/desktop desktop/sweetener

~~Optional if your activity has~~ only ~~the main ToolbarBox and the ActivityToolbar, obligatory~~ for ~~run the activty on~~ Linux desktops:

~~itemgroup.py~~

* Fill info.py with information about your activity. See [[Activity_Team/Sweetener#Activity_information|info.py fields]].

* Create a sugarized icon on activity/activity-(lower-name).svg where lower-name must be the same as the variable on info.py

* Generate the activity.info file trough the command make.

make activity

$ make activity

* Install it

python setup.py dev

$ python setup.py dev

* Make a .xo bundle

make xo_bundle

$ make xo_bundle

* Make a desktop tarball

$ make dist_tarball

== Activity information ==

@@ Line 2: / Line 2: @@
 == Maintainers ==
-*[[User:Daniel_Francis|Daniel Francis]]
+*[[User:Francis|Daniel Francis]]
 == Current Release ==
 At the moment it hasn't got a stable release. Clone the [http://git.sugarlabs.org/sweetener GIT Repository] and feel free to send patches, request merges or contact the maintainers.
+== Documentation ==
+The Sweetener documentation is available in [http://people.sugarlabs.org/francis/sweetenerdoc].
+Its source code is in Git:
+http://git.sugarlabs.org/sweetener/doc
 == Get started creating an activity==
 * Start a repository on [http://git.sugarlabs.org/ Git]
 * Clone Sweetener
-  git clone git://git.sugarlabs.org/sweetener/sweetener.git
+  $ git clone git://git.sugarlabs.org/sweetener/sweetener.git
 * Copy to your new activity directory the following files:
   Makefile
@@ Line 16: / Line 23: @@
   canvas.py
   info.py
- makescripts/
   options.py
   setup.py
@@ Line 24: / Line 30: @@
 * Make the following directories inside your activity:
   activity/
-  sugar/sweetener/
+  sugar/
-  desktop/sweetener/  # (Only if you want to run your activity on Linux desktops)
+  desktop/  # (Only if you want to run your activity on Linux desktops)
-* Copy basic modules:<br>  Sweetener is divided in modules, for a very basic activity, you'll need to copy to (sugar - desktop)/sweetener:
+* Clone sweetener submodules
-  __init__.py
+ $ git submodule add git://git.sugarlabs.org/sweetener/makescripts
-  basic_options.py
+ $ git submodule add git://git.sugarlabs.org/sweetener/sugar sugar/sweetener
-  item.py
-  itembox.py
+ # This is only for other Linux desktops.
-  stock.py
+ $ git submodule add git://git.sugarlabs.org/sweetener/desktop desktop/sweetener
-Optional if your activity has only the main ToolbarBox and the ActivityToolbar, obligatory for run the activty on Linux desktops:
-  itemgroup.py
 * Fill info.py with information about your activity. See [[Activity_Team/Sweetener#Activity_information|info.py fields]].
 * Create a sugarized icon on activity/activity-(lower-name).svg where lower-name must be the same as the variable on info.py
 * Generate the activity.info file trough the command make.
-   make activity
+   $ make activity
 * Install it
-   python setup.py dev
+   $ python setup.py dev
 * Make a .xo bundle
-   make xo_bundle
+   $ make xo_bundle
+* Make a desktop tarball
+  $ make dist_tarball
 == Activity information ==