iPrinciples.md - bitreich-style - Style guide for programmers. Err bitreich.org 70 hgit clone git://bitreich.org/bitreich-style URL:git://bitreich.org/bitreich-style bitreich.org 70 1Log /scm/bitreich-style/log.gph bitreich.org 70 1Files /scm/bitreich-style/files.gph bitreich.org 70 1Refs /scm/bitreich-style/refs.gph bitreich.org 70 1Tags /scm/bitreich-style/tag bitreich.org 70 1README /scm/bitreich-style/file/README.md.gph bitreich.org 70 1LICENSE /scm/bitreich-style/file/LICENSE.gph bitreich.org 70 i--- Err bitreich.org 70 iPrinciples.md (2077B) Err bitreich.org 70 i--- Err bitreich.org 70 i 1 # Principles Err bitreich.org 70 i 2 Err bitreich.org 70 i 3 Please first see the Bitreich Manifesto at Err bitreich.org 70 i 4 Err bitreich.org 70 i 5 gopher://bitreich.org/0/documents/bitreich-manifesto.md Err bitreich.org 70 i 6 Err bitreich.org 70 i 7 Err bitreich.org 70 i 8 ## KISP – Keep It Simple Perfect Err bitreich.org 70 i 9 Err bitreich.org 70 i 10 * Make a project do one thing well. Err bitreich.org 70 i 11 * A project can be done, does not need change just because. Err bitreich.org 70 i 12 Err bitreich.org 70 i 13 ## Commandline Interfaces Err bitreich.org 70 i 14 Err bitreich.org 70 i 15 * Always add a commandline interface so advanced users can script your Err bitreich.org 70 i 16 application and thus have more fun using it. Err bitreich.org 70 i 17 Err bitreich.org 70 i 18 ## When Possible Use GPLv3 Err bitreich.org 70 i 19 Err bitreich.org 70 i 20 * Use which license you like, but think of the future, when people might Err bitreich.org 70 i 21 use your software in war or other inhumane things. A life of open source Err bitreich.org 70 i 22 is not just about the CV and getting a Google job with a small home, bad Err bitreich.org 70 i 23 sex in marriage and a dog. Err bitreich.org 70 i 24 Err bitreich.org 70 i 25 ## Users are Programmers Err bitreich.org 70 i 26 Err bitreich.org 70 i 27 * First think of the programmers who might want to change your Err bitreich.org 70 i 28 application, help you, find bugs you have not spotted because you made Err bitreich.org 70 i 29 the application. Make this as simple as possible to contribute. Err bitreich.org 70 i 30 * Some ugly website which requires Gigabytes of RAM and big hardware is Err bitreich.org 70 i 31 not a simple access and will only make your own brain in the long run Err bitreich.org 70 i 32 fluid. Err bitreich.org 70 i 33 * Always add a Makefile using common methodologies and commands so Err bitreich.org 70 i 34 people can easily build your software. Do not make a build framework for Err bitreich.org 70 i 35 every new project. Make(1) knows most things needed, you may not have Err bitreich.org 70 i 36 read the documentation properly. Err bitreich.org 70 i 37 Err bitreich.org 70 i 38 ## Straightforward Documentation Err bitreich.org 70 i 39 Err bitreich.org 70 i 40 * When compiling software you realize, that people are using all kind of Err bitreich.org 70 i 41 bloated tools to generate documentation. Please do not be like that. Err bitreich.org 70 i 42 Think of all the people having to compile this to get your application. Err bitreich.org 70 i 43 Use what is more descriptive and easy to use: Man pages, a text or the Err bitreich.org 70 i 44 source. Err bitreich.org 70 i 45 Err bitreich.org 70 i 46 ## Applications Can Be Done Err bitreich.org 70 i 47 Err bitreich.org 70 i 48 * If your application does what it should do, but suddenly you have a Err bitreich.org 70 i 49 new big idea, make a new project, do not push the old one. There are old Err bitreich.org 70 i 50 users who do not think the same as you. Err bitreich.org 70 i 51 Err bitreich.org 70 i 52 ## Freedom Of Language Err bitreich.org 70 i 53 Err bitreich.org 70 i 54 * Use whatever language you like. Err bitreich.org 70 i 55 * Think of the dependencies. If you use slow to compile languages, you Err bitreich.org 70 i 56 will waste hours of lifetime of others. Do not be an asshole to those Err bitreich.org 70 i 57 people. Err bitreich.org 70 i 58 Err bitreich.org 70 .