Getting started with Maemo Garage
This is an article from the old midgard wiki that hasn't yet been fully updated for this wiki, please update it. Please see the talk page for discussion. |
See Task:Using_garage.maemo.org
Contents |
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 available 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 Garage user registration page can be found at the top of the Garages home page.
Registering a project
The second step, after logging in, is to register a project. You will find this link at the 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 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 Summarization
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
There are a number of open source software licenses to choose from.
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 https://garage.maemo.org/projects/unixprojectname, where unixprojectname is relaced with the selected name.
Working with Subversion
Main article: Subversion
Creating a website
To use Garage’s website hosting, a www
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 index.html
, and be placed in the www
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 delay of several 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 request a component in 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
- gForge the project hosting software use by Garage
- Version control with Subversion book a free online Subversion book, also available in print
- TortoiseSVN a Windows SVN client