From a61a41e16a92064d602c6640e941a4344a20e9e2 Mon Sep 17 00:00:00 2001 From: Koz Ross Date: Thu, 10 Nov 2016 15:09:49 +1300 Subject: [PATCH] Rephrasing contribution guide; removing CompCert due to notable non-freedom --- CONTRIBUTING.md | 25 +++++++++++++++++-------- README.md | 4 +--- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6d198e..bea57e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,19 +5,28 @@ alone, and I welcome pull requests. To make sure that we're all on the same page, here are some guidelines to follow for submitting pull requests for this list. -## Ensure that everything you link to is free (as in freedom) ## +## What would be great ## + +Obviously, it's your choice what you want to contribute - or not +contribute. However, if you're looking for something that would help awesome-c, +check the current issues, especially those tagged with 'help wanted'. Pull +requests addressing these are particularly great! + +## How to contribute ## + +Now for the mechanics of the process, and some do's and don't's. + +### Ensure that everything you link to is free (as in freedom) ### This is highly important - this list *only* contains freedom-respecting things! If you are sending a pull request linking to code, ensure it is licensed under a -[freedom-respecting license][1]; if you are linking to assets of any kind, make -sure that [they are the same][2]. For games, be especially careful that they are -both. +[freedom-respecting license][1]. -## Indicate the license for anything you add clearly ## +### Indicate the license for anything you add clearly ### -Ensure that you use the correct name for the license (as per [this][1] -or [this][2]), and indicate any further restrictions clearly. Also check if the -license is in use already - if it is, don't create another link to it. +Ensure that you use the correct name for the license (as per [this][1]), and +indicate any further restrictions clearly. Also check if the license is in use +already - if it is, don't create another link to it. ## Maintain alphabetical order within sections ## diff --git a/README.md b/README.md index bcd0fa2..830f5d1 100644 --- a/README.md +++ b/README.md @@ -80,8 +80,6 @@ These are tools to automate the building and testing of projects in C. ## Compilers ## * [Clang][38] - A compiler for LLVM. Supports C11. [NCSA][39]. -* [CompCert][269] - A fully-verified compiler. Supports almost all of - C89. [GNU GPLv2.1][8] or later. * [GCC][40] - Provides a C compiler as part of its compiler set. Supports C11. [GNU GPLv3][41] or later. * [PCC][74] - A venerable compiler. Supports C99. [Various licenses][75], all free. @@ -1073,7 +1071,7 @@ with respect to support for C. [266]: https://www.securecoding.cert.org/confluence/display/c/SEI+CERT+C+Coding+Standard [267]: http://blog.pkh.me/p/20-templating-in-c.html [268]: http://lipforge.ens-lyon.fr/www/crlibm/index.html -[269]: https://github.com/AbsInt/CompCert + [270]: https://github.com/docopt/docopt.c [271]: http://marek.vavrusa.com/c/memory/2015/02/20/memory/ [272]: http://kukuruku.co/hub/programming/i-do-not-know-c