Add CODE_OF_MERIT.md; update README (replace as README.md)

This commit is contained in:
BuildTools
2016-07-21 17:51:32 -04:00
parent 18aab87860
commit df65e2e7a7
3 changed files with 151 additions and 78 deletions
+52
View File
@@ -0,0 +1,52 @@
# Code of Merit
1. The project creators, lead developers, core team, constitute
the managing members of the project and have final say in every decision
of the project, technical or otherwise, including overruling previous decisions.
There are no limitations to this decisional power.
2. Contributions are an expected result of your membership on the project.
Don't expect others to do your work or help you with your work forever.
3. All members have the same opportunities to seek any challenge they want
within the project.
4. Authority or position in the project will be proportional
to the accrued contribution. Seniority must be earned.
5. Software is evolutive: the better implementations must supersede lesser
implementations. Technical advantage is the primary evaluation metric.
6. This is a space for technical prowess; topics outside of the project
will not be tolerated.
7. Non technical conflicts will be discussed in a separate space. Disruption
of the project will not be allowed.
8. Individual characteristics, including but not limited to,
body, sex, sexual preference, race, language, religion, nationality,
or political preferences are irrelevant in the scope of the project and
will not be taken into account concerning your value or that of your contribution
to the project.
9. Discuss or debate the idea, not the person.
10. There is no room for ambiguity: Ambiguity will be met with questioning;
further ambiguity will be met with silence. It is the responsibility
of the originator to provide requested context.
11. If something is illegal outside the scope of the project, it is illegal
in the scope of the project. This Code of Merit does not take precedence over
governing law.
12. This Code of Merit governs the technical procedures of the project not the
activities outside of it.
13. Participation on the project equates to agreement of this Code of Merit.
14. No objectives beyond the stated objectives of this project are relevant
to the project. Any intent to deviate the project from its original purpose
of existence will constitute grounds for remedial action which may include
expulsion from the project.
This document is the Code of Merit (http://code-of-merit.org), version 1.0.
-78
View File
@@ -1,78 +0,0 @@
-- INTRODUCTION --------------------------------------------------------------
LCDproc is a client/server suite including drivers for all kinds of nifty LCD
devices. The server works with different display sizes and supports several
serial devices: Matrix Orbital, Crystal Fontz, Bayrad, LB216, LCDM001
(kernelconcepts.de), Wirz-SLI and PIC-an-LCD; some devices connected to
the parallel port: HD44780, STV5730, T6963, SED1520 and SED1330; and also
some displays connected via USB: CFontzPacket, CwLnx, IOWarrior, LIS2 and
BWCT.
Various clients are available that display things like CPU load, system load,
memory usage, uptime, and a lot more.
LCDproc also supports key or remote control input for controlling the clients.
The client and the server use a TCP connection to communicate, so it is
possible to have a client on a box in Sweden showing its stats on a LCD
display in the United States.
Our web site is located at http://lcdproc.org/
For new versions and CVS go to http://sourceforge.net/projects/lcdproc/
Check there first for new versions or updates. For remaining questions,
you can ask the mailing list. For how to get on the mailing list, see
the main web site.
LCDproc was originally written by William W. Ferrell <wwf@splatwerks.org>
and Selene Scriven <lcdproc@toykeeper.net>.
-- INSTALLATION --------------------------------------------------------------
Refer to the INSTALL file included with this archive for installation
instructions (including how to connect the LCD to your system).
-- CHANGES -------------------------------------------------------------------
Woow... a lot. :)
See the ChangeLog file for more details.
-- HELPING OUT ---------------------------------------------------------------
The first thing you should do is join the mailing list, to do so, go to out
web site and click on MAIL and follow the instructions.
If you get the urge to help out by writing code, take a look at the TODO
file to see what we think that needs to be done. If you want to work on
something, or you want to add something different, tell it on the
mailing list. Maybe someone is already working on the part, and maybe someone
has already writen something that you can use. New ideas are always welcome !
To learn more about how LCDproc works, first have a look at the docs/
directory. Some important things are documented there, but because this is
still somewhat a big hacking project, some documentation will be missing ;)
-- SPECIAL THANKS ------------------------------------------------------------
LCDproc is a community effort, and as such we'd like to recognize everyone's
efforts. We've tried to list all the people that have contributed in the
CREDITS file. Thanks all !
-- LEGAL STUFF ---------------------------------------------------------------
LCDproc is Copyright (C) 1998-2006
William Ferrell, Selene Scriven and many other contributors.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
The file COPYING contains the GNU General Public License.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+99
View File
@@ -0,0 +1,99 @@
_Note: this project is currently being migrated from Sourceforge. Documentation
is still being updated to reflect this and we're still getting our bearings here
on GitHub, so please excuse the dust while we set up shop._
# Introduction
LCDproc is a client/server suite including drivers for all kinds of nifty LCD
devices. The server works with different display sizes and supports several
serial devices: Matrix Orbital, Crystal Fontz, Bayrad, LB216, LCDM001
(kernelconcepts.de), Wirz-SLI and PIC-an-LCD; some devices connected to
the parallel port: HD44780, STV5730, T6963, SED1520 and SED1330; and also
some displays connected via USB: CFontzPacket, CwLnx, IOWarrior, LIS2 and
BWCT.
Various clients are available that display things like CPU load, system load,
memory usage, uptime, and a lot more.
LCDproc also supports key or remote control input for controlling the clients.
The client and the server use a TCP connection to communicate, so it is
possible to have a client on a box in Sweden showing its stats on a LCD
display in the United States.
Visit our [website](http://lcdproc.org/) for more information. The project's
repository, issue tracking and pull request management can be found at
http://github.com/willfe/lcdproc.
LCDproc was originally written by William Ferrell <willfe@gmail.com>
and Selene Scriven <lcdproc@toykeeper.net>.
# Installation
Refer to the INSTALL file included with this archive for installation
instructions (including how to connect the LCD to your system).
# Changes
Woow... a lot. :)
See the ChangeLog file for more details.
# Contributing
If you've found a bug or want to add new functionality to LCDproc, feel free
to fork the repository, make your changes and send us a pull request. They're
always welcome!
If you want to help but need some inspiration, take a look at the TODO
file to see what we think that needs to be done.
To learn more about how LCDproc works, first have a look at the docs/
directory. Some important things are documented there, but because this is
still somewhat a big hacking project, some documentation will be missing ;)
## Code of Merit
This project adopts the Code of Merit, version 1.0, originally published
at http://code-of-merit.org/. Refer to CODE_OF_MERIT.md in this project's
source tree for a copy of this document.
In short, let's focus on writing software and leave the politics out of it.
# Special Thanks
LCDproc wouldn't be possible without the ongoing patience and efforts by its
amazing community of developers and users. We'd like to recognize everyone's
contributions to the project, and we've tried to list them all in the CREDITS
file. If we've overlooked your contributions, please let us know so we can
attribute your work immediately!
_From William Ferrell, original developer:_ This project is almost twenty years
old as I write this, and I'm so proud of what it's become over the years thanks
in no small part to the people (past and present) who not only contributed their
work and ideas to the project, but helped to manage and maintain it when I
couldn't. To see this project start as a small single-system utility program
supporting a single type of device and flourish into a client/server daemon used
around the world to drive all sorts of display devices is beyond anything I could
have ever hoped for, and I'm eternally grateful to everyone who's contributed
over the years. Thank you all for being part of this project and for making it
amazing. Here's to another twenty years! :)
# Legal Stuff
LCDproc is Copyright (C) 1998-2016
William Ferrell, Selene Scriven and many other contributors.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
The file COPYING contains the GNU General Public License.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.