README.md 1.54 KB
Newer Older
Ad Schellevis's avatar
Ad Schellevis committed
1
OPNsense GUI and system management
2
==================================
Ad Schellevis's avatar
Ad Schellevis committed
3

4 5 6
The OPNsense project invites developers to startcontributing to
the code base.  For your own purpose or even better to join us in
creating the best open source firewall available.
Ad Schellevis's avatar
Ad Schellevis committed
7

8 9 10
The build process has been designed to make it truly straightforward
and easy for anyone to build and code.  Being able to get the sources
and build it yourself is one of the key factors of open source software.
Ad Schellevis's avatar
Ad Schellevis committed
11

12 13 14
Although a lot of the code is still in flux, we try to publish the
direction we're taking on our wiki page.  The main outline of the new
codebase is available at:
Ad Schellevis's avatar
Ad Schellevis committed
15

16
https://wiki.opnsense.org/index.php/Develop:Architecture
Ad Schellevis's avatar
Ad Schellevis committed
17

18 19
Our aim is to gradually evolve to a new codebase instead of using a
big bang approach into something new.
Ad Schellevis's avatar
Ad Schellevis committed
20

21 22
Build tools
===========
Ad Schellevis's avatar
Ad Schellevis committed
23

24 25 26
To create working software like OPNsense you need the sources and the
tools to build it.  The build tools for OPNsense are freely available.
No strings attached.
Ad Schellevis's avatar
Ad Schellevis committed
27

28
Notes on how to build OPNsense can be found in the tools repository:
Ad Schellevis's avatar
Ad Schellevis committed
29

30
https://github.com/opnsense/tools
Ad Schellevis's avatar
Ad Schellevis committed
31

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
Contribute
==========

You can contribute to the project in many ways, e.g. testing
functionality, sending in bug reports or creating pull requests
directly via GitHub.  Any help is always very welcome!

License
=======

OPNsense is and will always be available under the 2-Clause BSD license:

http://opensource.org/licenses/BSD-2-Clause

Every contribution made to the project must be licensed under the
same conditions in order to keep OPNsense truly free and accessible
for everybody.