This wiki

If you would like to contribute new content, you can clone this wiki to your local host using the following command:

git clone git://git.suckless.org/sites

or

git clone https://git.suckless.org/sites

Then edit the wiki as you like. The markdown interpreter that is currently used on suckless.org is smu.

For adding new files, after you created them, use:

git add somefile

When you are finished, commit your changes with:

git commit -a

There you enter some meaningful commit message and end the editor.

To push your changes to the queue for the review by the suckless moderators, use:

git push git://git.suckless.org/sites

The review of your changes might take a few days, due to the different timezones we all live in.

Please make sure to update for incoming changes using »git pull«, before you push changes, to minimize merge problems.

The wiki repository above is world-writable.

Rules

Commit messages

Try to provide a clear subject and a clear commit message. The subject should not be more than 79 characters.

The format should be:

Subject not more than 79 characters<newline> <newline> Clear message describing the commit, line-wrapped to maximum of 79 characters. This message can be optional for trivial commits.

Markdown usage

Review markdown

A quick way to check what output will be generated on the site is to do:

smu -n < index.md | lynx -stdin

Please review your changes locally before pushing to avoid spamming the commit log and the review process.

Changes

The incoming changes to the wiki are all sent to the wiki@ mailinglist. See community for how to subscribe to this list.

Moderators

If you are a moderator, you will likely need the following procedure to pull the changes into the main repository:

see /git/scripts/updatewiki.sh

This script makes sure the changes are pulled in with the correct permissions.

Repositories

This is for moderators.

To create a new repository just git init --bare and symlink the git hooks (see the hooks/ directory in the other projects).