Changes

Jump to navigation Jump to search
Line 1: Line 1:  
=== Getting set up on IRC ===
 
=== Getting set up on IRC ===
   −
We use IRC for much of our communication. Unfortunate, Freenode, our IRC server, has been under attack by trolls of late, so we have had to lock down our channels. Therefore, you'll need to create a "registered account" to login. (You can use an IRC client or open https://webchat.freenode.net in a browser.)
+
We use IRC for some of our communication.  
 +
 
 +
IRC is unlike other chat services in that you should keep it open, otherwise you won't see anything that is said while you are gone.
 +
 
 +
Unfortunate, Freenode, our IRC network, has been under attack by trolls of late, so we have had to lock down our channels. Therefore, you'll need to create a "registered account" to login. (You can use an IRC client or open https://webchat.freenode.net in a browser.)
    
To register on Freenode:
 
To register on Freenode:
Line 9: Line 13:  
(Filling in your email and password)
 
(Filling in your email and password)
   −
Leave the window open if possible.  
+
Leave the IRC window open if possible.
   −
You will get an email that includes a command you'll need to type in to complete your registration. (It may take a while for the email to arrive.)
+
You will get an email that includes a command you'll need to type in to complete your registration. It may take a while for the email to arrive.
   −
Go back to the open IRC window and paste in the verification line from the email you received in the bottom space.
+
Go back to the open IRC window and paste in the verification line from the email you received in the entry space.
    
If you have closed the IRC window, you will need to reopen it.
 
If you have closed the IRC window, you will need to reopen it.
Line 41: Line 45:  
| rowspan="2" | You have only one computer and don't want to erase it
 
| rowspan="2" | You have only one computer and don't want to erase it
 
| Linux, Windows, macOS, or iOS
 
| Linux, Windows, macOS, or iOS
| Install virtualisation software, make a new virtual machine and install [[Live Build|Sugar Live Build]], [[SoaS|Sugar on a Stick]], [[Ubuntu]], [[Fedora]], or [[Debian]].  
+
| Install virtualisation software, make a new virtual machine and install [[Sugar Live Build]], [[SoaS|Sugar on a Stick]], [[Ubuntu]], [[Fedora]], or [[Debian]].  
 
|-
 
|-
 
| Linux
 
| Linux
Line 48: Line 52:  
| You have another computer that can be erased
 
| You have another computer that can be erased
 
| Doesn't matter
 
| Doesn't matter
| Install [[Live Build|Sugar Live Build]], [[SoaS|Sugar on a Stick]], [[Ubuntu]], [[Fedora]], or [[Debian]].
+
| Install [[Sugar Live Build]], [[SoaS|Sugar on a Stick]], [[Ubuntu]], [[Fedora]], or [[Debian]].
 
|}
 
|}
   −
What's the difference between Live Build, Sugar on a Stick and the various Linux options?
+
What's the difference between Sugar Live Build, Sugar on a Stick and the various Linux options?
    
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
!  !! Live Build (based on Debian) !! Sugar on a Stick (based on Fedora) !! Ubuntu, Debian or Fedora
+
!  !! Sugar Live Build (based on Debian) !! Sugar on a Stick (based on Fedora) !! Ubuntu, Debian or Fedora
 
|-
 
|-
 
! Sugar desktop user experience on startup
 
! Sugar desktop user experience on startup
| yes, 0.112 || yes, 0.110 || no, must install packages
+
| yes, 0.116 || yes, 0.114 || no, must install packages
 +
|-
 +
! Good for Set up the Sugar Desktop task
 +
| yes || yes || yes, but not Ubuntu 19.10
 
|-
 
|-
! Good for Sugar activity development
+
! Good for Sugar activity development tasks
 
| yes || no, must install packages || no, must install packages
 
| yes || no, must install packages || no, must install packages
 +
|-
 +
! Good for Port to Python 3 tasks
 +
| yes || no, must install from source || no, must install from source
 
|-
 
|-
 
! Good for Sugar desktop module development
 
! Good for Sugar desktop module development
Line 73: Line 83:  
|}
 
|}
   −
See also [https://developer.sugarlabs.org/dev-environment.md.html Setup a development environment].
+
See also [https://github.com/sugarlabs/sugar/blob/master/docs/development-environment.md Setup a development environment].
    
=== Getting started with coding in Sugar ===
 
=== Getting started with coding in Sugar ===
Line 92: Line 102:  
* For both, you will need knowledge of Sugar activity development, see the book [http://www.flossmanuals.net/make-your-own-sugar-activities/ Make Your Own Sugar Activities!]
 
* For both, you will need knowledge of Sugar activity development, see the book [http://www.flossmanuals.net/make-your-own-sugar-activities/ Make Your Own Sugar Activities!]
   −
Python programmers, you must run [http://legacy.python.org/dev/peps/pep-0008/#introduction pep8] and pyflakes on your code ''before'' submitting your patches.
+
Python programmers, you should run [http://legacy.python.org/dev/peps/pep-0008/#introduction pep8] and flake8 on your changes ''before'' submitting your patches.
    
=== Getting started with GIT ===
 
=== Getting started with GIT ===
   −
Some knowledge of git is important as your work will be submitted to our [https://github.com/sugarlabs git repositories]. The basic mechanism is a pull-request (PR), which is explained in [https://developer.sugarlabs.org/contributing.md.html Contributing].
+
Some knowledge of git is important as your work will be submitted to our [https://github.com/sugarlabs git repositories]. The basic mechanism is a pull-request (PR), which is explained in [https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md Contributing].
   −
''It is required that you follow the steps outlined on the [https://developer.sugarlabs.org/contributing.md.html Contributing] page when doing coding and documentation tasks in GCI.''
+
''It is required that you follow the steps outlined on the [https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md Contributing] page when doing coding and documentation tasks in GCI.''
    
GitHub provides a [https://try.github.io/levels/1/challenges/1 tutorial]. There are many other guides to GIT as well.
 
GitHub provides a [https://try.github.io/levels/1/challenges/1 tutorial]. There are many other guides to GIT as well.
    
Our old bug tracker is https://bugs.sugarlabs.org, but these days, we mostly report bugs using the ''issues'' feature of GitHub. (See https://guides.github.com/features/issues/ for details on GitHub Issues.)
 
Our old bug tracker is https://bugs.sugarlabs.org, but these days, we mostly report bugs using the ''issues'' feature of GitHub. (See https://guides.github.com/features/issues/ for details on GitHub Issues.)
 +
 +
=== Making a Pull Request ===
 +
 +
We detail the Pull Request process in [https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md here] in our [https://github.com/sugarlabs/sugar-docs docs] on Git Hub.
 +
 +
A few things to keep in mind:
 +
* Do not link commits or pull requests to a GCI task, as these are transient and not public,
 +
* Link commits and pull requests to any relevant GitHub issue, and if there is no such issue, say so,
 +
* Explain the problem and how it was solved in your commit message, not in your pull request.
    
=== Setting up a Sugarizer environment ===
 
=== Setting up a Sugarizer environment ===
   −
Use your computer.  See also [[#Getting started with Sugarizer]].=== Getting started with Sugarizer ===
     −
Sugar Web Framework is the [https://github.com/sugarlabs/sugar-docs/blob/master/web-architecture.md JavaScript Framework for Sugar]. [http://sugarizer.org Sugarizer] is a subset of Sugar that allow running activities developed with Sugar Web Framework on any web browser. Sugarizer is also available as Android, iOS, Firefox OS and Chrome Web App.
+
{| class="wikitable"
 +
|-
 +
! Your Equipment !! Your Operating System !! Our Recommendation
 +
|-
 +
| You have a computer
 +
| Linux, Windows or macOS
 +
| Install the [https://sugarizer.org/#apps Sugarizer package] for your operating system.
 +
|-
 +
| You have a tablet or phone
 +
| Android
 +
| Install the [https://sugarizer.org/#apps Sugarizer app] from Google Play.
 +
|-
 +
| You have a tablet or phone
 +
| iOS
 +
| Install the [https://sugarizer.org/#apps Sugarizer app] from the App Store.
 +
|-
 +
| You have just a browser
 +
| Any
 +
| Test Sugarizer on the [https://try.sugarizer.org/ Sugarizer web site].
 +
|}
 +
See also [[#Getting started with coding in Sugarizer]].
 +
 
 +
=== Getting started with coding in Sugarizer ===
 +
 
 +
A good way to start coding in Sugarizer is to complete the [https://github.com/llaske/sugarizer/blob/dev/docs/tutorial.md Sugarizer activity development tutorial].
 +
To learn more about Sugarizer architecture, see the dedicated page [https://github.com/llaske/sugarizer/blob/dev/docs/architecture.md here].
    
=== Getting a wiki account ===
 
=== Getting a wiki account ===

Navigation menu