sites

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

index.md (3102B)

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