sites

public wiki contents of suckless.org
git clone git://git.suckless.org/sites
Log | Files | Refs

index.md (2988B)

      1 This wiki
      2 =========
      3 If you would like to contribute new content, you can clone this wiki to your
      4 local host using the following command:
      5 
      6 	git clone git://git.suckless.org/sites
      7 
      8 or
      9 
     10 	git clone https://git.suckless.org/sites
     11 
     12 Then edit the wiki as you like. The markdown interpreter that is currently
     13 used on suckless.org is
     14 [smu](https://github.com/Gottox/smu).
     15 
     16 For adding new files, after you created them, use:
     17 
     18 	git add somefile
     19 
     20 When you are finished, commit your changes with:
     21 
     22 	git commit -a
     23 
     24 There you enter some meaningful commit message and end the editor.
     25 
     26 To push your changes to the queue for the review by the suckless moderators,
     27 use:
     28 
     29 	git push git://git.suckless.org/sites
     30 
     31 The review of your changes might take a few days, due to the different
     32 timezones we all live in.
     33 
     34 __Please make sure to update for incoming changes using »git pull«, before you
     35 push changes, to minimize merge problems.__
     36 
     37 The wiki repository above is world-writable.
     38 
     39 Rules
     40 -----
     41 * If any abuse happens, we will disable world-writable access. Keep this in
     42   mind! We kindly ask you to not destroy the way we like to collaborate with
     43   the community.
     44 * Please do not add files bigger than *100kb*.
     45 * Please do not add unscaled large images. If needed provide a thumbnail.
     46 * Please do not add any binary files except screenshots or images related to
     47   our software.
     48 * For datetimes use the international date format: yyyy-mm-dd.
     49 * The patches should be hosted in the repository itself. Providing an
     50   additional mirror with the same content is OK.
     51 * Inline HTML, HTML files or inline JavaScript is not allowed and not supported.
     52 
     53 Commit messages
     54 ---------------
     55 Try to provide a clear subject and a clear commit message.
     56 The subject should not be more than 79 characters.
     57 
     58 The format should be:
     59 
     60 Subject not more than 79 characters<newline>
     61 <newline>
     62 Clear message describing the commit, line-wrapped to maximum of 79 characters.
     63 This message can be optional for trivial commits.
     64 
     65 Markdown usage
     66 --------------
     67 * The extension of newly created Markdown files must be `.md`.
     68 * There are some dialects of Markdown, please don't use too "advanced" features.
     69 
     70 Review markdown
     71 ---------------
     72 A quick way to check what output will be generated on the site is to do:
     73 
     74 	smu -n < index.md | lynx -stdin
     75 
     76 Please review your changes locally before pushing to avoid spamming the commit
     77 log and the review process.
     78 
     79 Changes
     80 -------
     81 The incoming changes to the wiki are all sent to the wiki@
     82 mailinglist. See [community](//suckless.org/community) for how to
     83 subscribe to this list.
     84 
     85 Moderators
     86 ----------
     87 If you are a moderator, you will likely need the following procedure to pull
     88 the changes into the main repository:
     89 
     90 	see /git/scripts/updatewiki.sh
     91 
     92 This script makes sure the changes are pulled in with the correct permissions.
     93 
     94 Repositories
     95 ------------
     96 This is for moderators.
     97 
     98 To create a new repository just git init --bare and symlink the git hooks (see
     99 the hooks/ directory in the other projects).