|author||Felix Wolfsteller <firstname.lastname@example.org>||2015-12-01 07:54:16 +0100|
|committer||Felix Wolfsteller <email@example.com>||2015-12-01 07:54:16 +0100|
add README.md with basic and contributors information.
Diffstat (limited to 'README.md')
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
@@ -0,0 +1,23 @@
+The pfSense project is a free network firewall distribution, based on the FreeBSD operating system with a custom kernel and including third party free software packages for additional functionality. pfSense software, with the help of the package system, is able to provide the same functionality or more of common commercial firewalls, without any of the artificial limitations. It has successfully replaced every big name commercial firewall you can imagine in numerous installations around the world, including Check Point, Cisco PIX, Cisco ASA, Juniper, Sonicwall, Netgear, Watchguard, Astaro, and more.
+pfSense software includes a web interface for the configuration of all included components. There is no need for any UNIX knowledge, no need to use the command line for anything, and no need to ever manually edit any rule sets. Users familiar with commercial firewalls catch on to the web interface quickly, though there can be a learning curve for users not familiar with commercial-grade firewalls.
+pfSense is Copyright 2004-2015 [Electric Sheep Fencing LLC](https://electricsheepfencing.com "Electric Sheep Fencing LLC homepage") and published under a BSD license.
+Read more at [https://pfsense.org/](https://pfsense.org/ "The pfSense homepage") and support the team with a Gold Membership Subscription, bundled hardware appliances or commercial support.
+Contact [firstname.lastname@example.org](mailto:email@example.com "Mail to firstname.lastname@example.org) to get involved.
+* Review our Developer Style Guide: https://doc.pfsense.org/index.php/Developer_Style_Guide
+* Familiarize yourself with our git repositories (and github in general): https://github.com/pfsense
+* Review the list of open bug reports and other issues: https://redmine.pfsense.org/projects/pfsense/issues
+* Review and Sign the license agreement (LA) and either the Individual or Corporate CLA: https://forum.pfsense.org/index.php?topic=76132.msg415051#msg415051
+Once you have the LA and CLA complete, you can submit changes as pull requests on github: https://help.github.com/articles/using-pull-requests/
+Our developers will review the submissions, offer feedback, and merge the changes if they are acceptable.