WARNING
This initiative and the Website, database, communication or other content are mainly created and maintained by @niamtokik (opens new window). All data available here are freely available Friendly Router Github (opens new window) organization page.
All modification coming from other participant will have validation and release delay.
# Licensing
All code or examples produced and shared here MUST be in licensed using OpenBSD License (opens new window).
Copyright (c) YYYY YOUR-NAME-HERE <user@your.dom.ain>
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
All texts or other information not directly linked to technological properties MUST be licensed under CC BY-SA (opens new window) license.
CC BY-SA: This license allows reusers to distribute, remix, adapt, and build
upon the material in any medium or format, so long as attribution is
given to the creator. The license allows for commercial use. If you
remix, adapt, or build upon the material, you must license the
modified material under identical terms.
CC BY-SA includes the following elements:
BY – Credit must be given to the creator
SA – Adaptations must be shared under the same terms
# Participating
There is many ways to participate, here few of them. More examples and content will be added soon. These processes will evolve and will be also available in main repository.
# Create and/or Update Content (Github)
Create a Github account.
Fork friendly-router (opens new window) repository on your own profile.
Create your content on a dedicated branch called something like
database/${manufacturer}-${device}where${manufacturer}is a lower case name of the constructor (e.g.asus,intel) and${device}is the identifier of the hardware (e.g.apu2c6).Create Pull Request with the data you want to add.
Wait for comment and validation.
If everything is okay, changes will be available on friendly-router.github.io (opens new window) github repository.
Your name will be added in Thanks page, with the description of your change and any kind of message you want to add.
# Create and/or Update Content (Mail)
Send an encrypted and signed text formated mail to the one present in contacts section containing the content.
A new Merge Request will be added and the author will be "Anonymous", except if an author name was explicitely requested by the sender.
# Donations
Please contact us.
# Sponsoring
Please contact us.
# Goodies and Merchandising
Please contact us.
# Maintenance Cost and Service List
This is a small, open and free open-source project but like any project, there is some existing cost. Here the actual list of the services used:
| Service | Cost | Notes and Comments |
|---|---|---|
| Domain name | €18.79/year | friendly-router.org (Gandi) |
| Github Account | free | https://github.com/friendly-router |
| Gitlab Account | free | https://gitlab.com/friendly-router |
| Mastodon | free | https://bsd.network/@friendlyrouter |
| IRC | free | irc.freenode.net/#friendly-router |
| free | https://twitter.com/FriendlyRouter |