diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 55 |
1 files changed, 33 insertions, 22 deletions
@@ -1,6 +1,7 @@ = Setup a supported distribution = -For all the distributions your user need admin rights (i.e. it should be able to run the su command). +For all the distributions your user need admin rights (i.e. it should +be able to run the su command). Fedora 17 (32-bit and 64-bit) Ubuntu 12.04 (32-bit and 64-bit) @@ -16,19 +17,22 @@ That should be all you need to have sugar running! = Developing and contributing = -First of all enter the sugar-build shell, this will ensure you have the right environment and will provide a few useful extra commands. +First of all enter the sugar-build shell, this will ensure you have +the right environment and will provide a few useful extra commands. make shell -You can find all the sources in sugar-build/source. Enter the desired module -directory and apply your modifications. To test them out, you need to install -the new code and start sugar +You can find all the sources in sugar-build/source. Enter the desired +module directory and apply your modifications. To test them out, you +need to install the new code and start sugar make install start-sugar -Finally, when you have something worth contributing to the community, you should -send patches to the development mailing list. First of all commit all of your changes to git. Now to send the patches you just run +Finally, when you have something worth contributing to the community, +you should send patches to the development mailing list. First of all +commit all of your changes to git. Now to send the patches you just +run send-patches @@ -38,25 +42,31 @@ To generate bug report information make bug-report -I expect a lot of tweaks will be necessary before this is stable. In the future distributions upgrades will also be problematic. We need the build to work out of the box 99% of the time for everyone, so if stuff breaks don't please don't be shy and always report a bug (patches are appreciated of course but not required). If you install an activity and it doesn't work, that might also be a sugar-build bug, in doubt just report it. +I expect a lot of tweaks will be necessary before this is stable. In +the future distributions upgrades will also be problematic. We need +the build to work out of the box 99% of the time for everyone, so if +stuff breaks don't please don't be shy and always report a bug +(patches are appreciated of course but not required). If you install +an activity and it doesn't work, that might also be a sugar-build bug, +in doubt just report it. = Reference = == Makefile targets reference == -make all Build and install activities -make build Build all the modules. -make run Run sugar. -make build-[module] Build a single module. -make clean Delete build artifacts and sources. -make bug-report Generate a bug report. -make shell Open a shell with proper build environment. -make test Run UI tests +make all Build and install activities +make build Build all the modules. +make run Run sugar. +make build-[module] Build a single module. +make clean Delete build artifacts and sources. +make bug-report Generate a bug report. +make shell Open a shell with proper build environment. +make test Run UI tests == Shell commands reference == -start-sugar Start sugar. -send-patches Send local commits as patches for review. +start-sugar Start sugar. +send-patches Send local commits as patches for review. Use --help for more informations about each command. @@ -64,7 +74,8 @@ Use --help for more informations about each command. SUGAR_OUTPUT -Sugar does not run properly on multiple video outputs, so we need to select one -and turn off the others. By default we select the first output listed by RandR. -You can set this variable to override that with any other of the connected -outputs reported by xrandr command, for example VGA1 if you have an external monitor. +Sugar does not run properly on multiple video outputs, so we need to +select one and turn off the others. By default we select the first +output listed by RandR. You can set this variable to override that +with any other of the connected outputs reported by xrandr command, +for example VGA1 if you have an external monitor. |