Because the submit form documents just the basics, here is a longer explanation of what each field does.
General description
→ Project ID:
Becomes your project URL name on freshcode. You can use letters a-z, numbers 0-9, hyphen - and _ underscore. It may additionally end in a language tag .py or .cpp for example.
It…
Because the submit form documents just the basics, here is a longer explanation of what each field does.
General description
→ Project ID:
Becomes your project URL name on freshcode. You can use letters a-z
, numbers 0-9
, hyphen -
and _
underscore. It may additionally end in a language tag .py
or .cpp
for example.
It's supposed to be your projects basename in the URL http://freshcode.club/projects/PROJ-NAME
.
Spaces and inacceptable characters will be stripped on submission.
→ Title:
Is the full name of your project. While you can add a little elaboration, try not to use it as description field already. (We'll add a separate "oneline" or "summary" later..)
→ Homepage:
Should be your projects homepage URL, or github or sourceforge reference.
→ Description:
Explain what your project is about. List all the features. It doesn't have to be a lengthy text, but should round-up what advantages your implementation has over similar apps. You can even add future goals, or anything that may capture user interest.
→ License:
Pick one of the existing open source project licenses.
If there's no exact match, chose "Other" initially, and flag for moderator attention. Custom license names can be added still. Distributions may often pick "Mixed" instead; if the project is covered under different individual licenses.
→ Tags:
Should list a few categories to describe your project. Add the implementation language, core features, a target audience descriptor (end-user, developers, administrator etc.) if you want.
Note that tags should be made up of letters primarily, or -
hyphen-separated categories. You can list multiple tags by separating them with spaces and/or commas. Such as c++, python, graphic, editor, image, end-user
.
You can also pick a few general ones from the Topic/Trove box.
→ Image:
If you have a screenshot or logo for your project on your project homepage, just add an URL to it here. This will be used as preview.
If you leave this field empty, don't worry, a homepage screenshot will be generated then instead.
Releases
→ Version:
Your current project version. (Leave empty if there isn't one yet).
Version numbers may be made up of numbers, dots, hyphes, underscores, and -xyz suffixes. This field however also accepts textual version descriptors.
Note that you'll generate a frontpage entry whenever you add or change the version field.
→ State:
Broadly categorize stability or finishedness of your project.
→ Scope:
New releases can be minor or major feature changes or bugfixes. What qualifies as minor or major may be interpreted differently by each project. (For example the Linux kernel adding 100 new drivers might be minor to them, but a small CLI tool changing some behaviour might amount to a major feature change).
→ Changes:
Is a summary of what new features or changes and bugfixes your newest release adds. Write this end-user readable, in a list style, but avoid the *
decorators if possible.
→ Download URL:
Is either a link to a zip/tar, or a download landing page.
If your zip/tar file releases consistently contain the current version number of your project, then you may wish to utilize the $version
placeholder. - So for future updates you don't have to update this download URL again.
→ Other URLs:
You can add further project links. This field accepts a line-wise or comma-separated list of Link-Name = http://example.org/
fields.
You often may want to add GitHub or SourceForge URLs here, or a link to the manual/documentation, or version control system. You can just as well list DEB
or RPM
or APT-PPA
download links, or release notes, a user forum, or a mailing-list= entry.
Automatic Release Tracking
See the Autoupdate Howto..
Submit
→ Submitter:
Just give your name here, or a nickname of yours. You may additionally (comma-separated) list a registered gravatar@example.com
address, or use your username@github
, username@sourceforge
or username@launchpad
. If so, a user icon will be presented later.
→ Lock:
If you've logged in beforehand, then just click on the greenly-dotted lock
field. This will copy your exact OpenID id into this field. Which in turn will prevent editing of your project submission by anyone else. (Except editors/moderators on freshcode.)
→ Terms and Conditions:
This section just requires to check two boxes. It's mainly an obfuscation for spambots currently. (No need for Captchas or really requiring OpenID yet.)