Editing Getting started with Maemo Garage

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

See [[Task:Using_garage.maemo.org]]

== About Garage ==

Garage is a software hosting platform for Maemo-related projects.

=== Services provided by Garage ===

* Website hosting
* Bugtracker
** Also includes a patch tracker, support tracker and feature request tracker
* Subversion hosting ([[Git_For_Garage|Git]] available [[Git_For_Garage#Requesting Git for your Garage project |on request]])
** Web-based repository browsing
* Project file hosting (binary and source release archives)
** Ability to track number of downloads

== Creating a Garage project ==

=== Registering a Garage account ===

To create a Garage project you must have a Garage user account. The [https://garage.maemo.org/account/register.php Garage user registration page] can be found at the top of the [https://garage.maemo.org/ Garage home page].

=== Registering a project ===

The second step, after logging in, is to [https://garage.maemo.org/register/ register a project]. You will find this link at the [https://garage.maemo.org/my/ top of your developer's home page].

The list below shows requirements of a Garage project. You may be sucessful in acquiring project space if you remember the text on the [https://garage.maemo.org/ Garage home page], ‘This site is meant for hosting various software projects related to the maemo developer platform.’  Each project must determine these settings for themselves.

==== Project purpose and summary ====

The project purpose is perhaps one of the most important items on the list of requirements. This statement says what you plan to do. The site administrator will approve your project primarily based on this statement. Remember that the admins are looking to see if your goal matches their intent of the site. Test projects will not be approved. You can either download a copy of the gForge software or try one of their demo sites.

==== License ====

Your project must have an open source license. Some suitable licenses are [http://opensource.org/licenses/category listed by the Open Source Initiative].

==== Project Public Description ====

Your project public description is your first communication with users. Please pick it accordingly with a marketing hat on your head.  However, don't let it stop progress if you cannot think of something clearly that describes your project. It can be revised later.

==== Project Unix Name ====

The final requirement is what name will you use to plant your project on the Garage servers. This name will be used in many tools and URLs, such as the project information page at <nowiki>https://garage.maemo.org/projects/unixprojectname</nowiki>, where ''unixprojectname'' is replaced with the selected name.

== Working with Subversion ==

{{main|Subversion}}

== Creating a website ==

To use Garage’s website hosting, a <code>www</code> directory containing a static website must be added as a toplevel directory in the Subversion (or Git) repository of the project. The index page should be named <code>index.html</code>, and be placed in the <code>www</code> directory. Changes to a project website must be made to the source code repository, like any source code changes, but are only visible on the project website after a [http://lists.maemo.org/pipermail/maemo-developers/2009-March/018717.html delay of upto 20 minutes]. A project website can be accessed from the project information page.

== Trackers and tasks ==

Trackers are provided for management of bugs, feature requests, patches and support discussion. A ‘Tracker’ link is available from the project information page if the tracker is enabled for a project. As an alternative to the Garage tracker, it is possible for a Garage project that has been uploaded to [[Extras]] to [[Bugs:Adding_Extra_products|request a component]] in [https://bugs.maemo.org/ maemo.org Bugzilla].

== Making releases ==

Source code and binary releases can be distributed with Garage with the ‘File’ link from the project information page. A release can be made with a changelog and release notes, so that users may read this information without having to download a release in full. A download count is provided for each release. Rather than distributing binary packages through Garage, it is recomended to upload packages to [[Extras]] to get the widest exposure and to make installation easier for users.

== External resources ==

* [http://gforge.org/ gForge] the project hosting software used by Garage
* [http://svnbook.red-bean.com/ Version control with Subversion book] a free online Subversion book, also available in print
* [http://tortoisesvn.tigris.org/ TortoiseSVN] a Windows SVN client
[[Category:Development]]

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Templates used on this page:

Template:Main (view source) (protected)

Retrieved from "https://wiki.maemo.org/Getting_started_with_Maemo_Garage"

Personal tools

Navigation

Views

Editing Getting started with Maemo Garage

@@ Line 29: / Line 29: @@
 ==== Project purpose and summary ====
-The project purpose is perhaps one of the most important items on the list of requirements. The site administrator will approve your project primarily based on this statement.
+The project purpose is perhaps one of the most important items on the list of requirements. This statement says what you plan to do. The site administrator will approve your project primarily based on this statement. Remember that the admins are looking to see if your goal matches their intent of the site. Test projects will not be approved. You can either download a copy of the gForge software or try one of their demo sites.
 ==== License ====
@@ Line 37: / Line 37: @@
 ==== Project Public Description ====
-Your project public description is your first communication with users, and so it is important to offer a concise outline of the project. However, the description can be revised at a later time.
+Your project public description is your first communication with users. Please pick it accordingly with a marketing hat on your head.  However, don't let it stop progress if you cannot think of something clearly that describes your project. It can be revised later.
 ==== Project Unix Name ====
-The final requirement is the name that will be used for your project on the Garage servers. This name will be used in many tools and URLs, such as the project information page at <nowiki>https://garage.maemo.org/projects/unixprojectname</nowiki>, where ''unixprojectname'' is replaced with the selected name.
+The final requirement is what name will you use to plant your project on the Garage servers. This name will be used in many tools and URLs, such as the project information page at <nowiki>https://garage.maemo.org/projects/unixprojectname</nowiki>, where ''unixprojectname'' is replaced with the selected name.
 == Working with Subversion ==