webadmin/bpfire
1
0
Fork 0
mirror of https://github.com/vincentmli/bpfire.git synced 2026-04-28 11:43:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve README and CONTRIBUTING

Browse Source 
- Strip tailing whitespaces
- Use shorter line length to make reading the files with editors or
  terminals without automatic line break easier
- Slightly improve the content of these files

Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
This commit is contained in:
Peter Müller
2022-03-21 13:47:58 +00:00
parent a5a5857865
commit e6cbe7563f
2 changed files with 36 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -1,9 +1,14 @@
# IPFire # IPFire 2.x - The Open Source Firewall
# What is IPFire? # What is IPFire?
IPFire is a hardened, versatile, state-of-the-art Open Source firewall based on Linux. Its ease of use, high performance in any scenario and extensibility make it usable for everyone. For a full list of features have a look [here](https://www.ipfire.org/features). IPFire is a hardened, versatile, state-of-the-art Open Source firewall based on
This repository contains the source code which is used to build the whole distribution from scratch. Linux. Its ease of use, high performance in any scenario and extensibility make
it usable for everyone. For a full list of features have a look [here](https://www.ipfire.org/features).
This repository contains the source code of IPFire 2.x which is used to build
the whole distribution from scratch, since IPFire is not based on any other
distribution.
# Where can I get IPFire? # Where can I get IPFire?
@@ -11,15 +16,14 @@ Just head over to https://www.ipfire.org/download
# How do I use this software? # How do I use this software?
We have a long and detailed wiki located [here](https://wiki.ipfire.org/) which should answers most of your questions. We have a long and detailed wiki located [here](https://wiki.ipfire.org/) which
should answers most of your questions.
# But I have some questions left. Where can I get support? # But I have some questions left. Where can I get support?
You can ask your question at our community located [here](https://community.ipfire.org/). You can ask your question at our community located [here](https://community.ipfire.org/).
A complete list of our support options can be found [here](https://www.ipfire.org/support) A complete list of our support channels can be found [here](https://www.ipfire.org/support).
# How can I contribute? # How can I contribute?
We have another document for this. Please look [here](doc/CONTRIBUTING.md). We have another document for this. Please look [here](doc/CONTRIBUTING.md).

35
doc/CONTRIBUTING.md
View File

@@ -1,34 +1,45 @@
# How can I help? # How can I help?
You can help in numerous ways. This document should give you an overview of what is possible and how you can get involved. You can help in numerous ways. This document should give you an overview of what
It will **not** give you all information you need to successfully contribute to avoid content duplication between this document and our [wiki](https://wiki.ipfire.org/). is possible and how you can get involved. It will **not** give you all information
Instead, it should guide you to the right places to look for further information. you need to successfully contribute to avoid content duplication between this
document and our [wiki](https://wiki.ipfire.org/). Instead, it should guide you
to the right places to look for further information.
## Development ## Development
All information is available in the [development section](https://wiki.ipfire.org/devel) of our wiki. The following is a very short overview about the most important topics. All information is available in the [development section](https://wiki.ipfire.org/devel)
of our wiki. The following is a very short overview of the most important topics.
### Contact ### Contact
We use a mailing list development@lists.ipfire.org for our communication. For the list archive and registration, see [here](http://lists.ipfire.org/mailman/listinfo/development) We use the mailing list `<development@lists.ipfire.org>` for our communication. For the
list archive and registration, see [here](http://lists.ipfire.org/mailman/listinfo/development).
### Source Code ### Source Code
We use our own infrastructure for code hosting, located under git.ipfire.org. The GitHub repositories are **only** mirrors of the main repositories located under git.ipfire.org. We use our own infrastructure for code hosting, accessible at `git.ipfire.org`. The
GitHub repositories are **only** mirrors of `git.ipfire.org`, available as a courtesy
to the internet community.
### How to build the distribution? ### How to build the distribution?
In order to contribute, you certainly need to build the distribution at some point. See [here](https://wiki.ipfire.org/devel/ipfire-2-x/build-howto) for a long guide how to do that. In order to contribute, you certainly need to build the distribution at some point.
See [here](https://wiki.ipfire.org/devel/ipfire-2-x/build-howto) for a long guide
how to do that.
### Bugs ### Reporting bugs
We have a bug tracker located [here](https://wiki.ipfire.org/devel/bugzilla). Further information can be found in our [wiki](https://wiki.ipfire.org/devel/bugzilla). We have a bug tracker located [here](https://wiki.ipfire.org/devel/bugzilla). Further
We do **not** use GitHub for tracking bugs. information can be found in our [wiki](https://wiki.ipfire.org/devel/bugzilla). We do
**not** use GitHub for tracking bugs.
### Contribute changes to the source code ### Contribute changes to the source code
First: **we do not accept GitHub pull requests!** We are working with patches which are sent to our mailing list development@lists.ipfire.org . Unfortunately, we do not accept GitHub pull requests. Instead, we are working with patches
This process might be a bit tricky in the beginning. That's why you can find more information how to do this [here](https://wiki.ipfire.org/devel/submit-patches) which are sent to our mailing list `<development@lists.ipfire.org>`. This process might
be a bit tricky in the beginning. That's why you can find more information how to do
this [here](https://wiki.ipfire.org/devel/submit-patches).