https://github.com/XQF/xqf/wiki
This commit is contained in:
Thomas Debesse
parent
4db00343d1
commit
a361624745
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,4 +1,3 @@
|
||||
ABOUT-NLS
|
||||
COPYING
|
||||
INSTALL
|
||||
README
|
||||
|
||||
95
AUTHORS.md
95
AUTHORS.md
@ -3,71 +3,60 @@ Author
|
||||
|
||||
* Roman Pozlevich <roma@botik.ru>
|
||||
|
||||
Significant contributors
|
||||
------------------------
|
||||
|
||||
* Bill Adams <bill@evilbill.org>
|
||||
* Alex Burger <alex_b@users.sf.net>
|
||||
* Ludwig Nussel <ludwig.nussel@suse.de>
|
||||
* Jordi Mallach <jordi@debian.org>
|
||||
Maintainers
|
||||
-----------
|
||||
|
||||
* Thomas Debesse <xqf@illwieckz.net>
|
||||
* Jordi Mallach <jordi@debian.org>
|
||||
* Ludwig Nussel <ludwig.nussel@suse.de>
|
||||
* Alex Burger <alex_b@users.sf.net>
|
||||
* Bill Adams <mailto:bill@evilbill.org>
|
||||
|
||||
|
||||
Contributors
|
||||
------------
|
||||
|
||||
* Zack Middleton <zturtleman@gmail.com>
|
||||
|
||||
Other contributors
|
||||
------------------
|
||||
|
||||
* Artem Vorotnikov <artem@vorotnikov.me>
|
||||
* Gilles Crettenand <gilles.crettenand@liip.ch>
|
||||
* Arnaud Bonatti <arnaud.bonatti@gmail.com>
|
||||
* Spanti Nicola <rydroid_dev@yahoo.com>
|
||||
* Witold Piłat <witold.pilat@gmail.com>
|
||||
* Jochen Baier <email@jochen-baier.de>
|
||||
* Witold Piłat <witold.pilat@gmail.com>
|
||||
* Victor BE <victorbe@users.sf.net>
|
||||
* Jo Shields <directhex@apebox.org>
|
||||
* Sven Joachim <svenjoac@gmx.de>
|
||||
* Lars Wirzenius <liw@iki.fi>
|
||||
* Victor BE <victorbe@users.sf.net>
|
||||
* Gilles Crettenand <gilles.crettenand@liip.ch>
|
||||
* Spanti Nicola <rydroid_dev@yahoo.com>
|
||||
* Luca Camillo <kamy@tutorials.it>
|
||||
* Alexander Hambalgo
|
||||
* Philipp Thomas
|
||||
* O Sezer
|
||||
* Jorge Hodge
|
||||
* Steffen Pankratz
|
||||
* Jason Santos
|
||||
* Jochen Baier
|
||||
* Matze Braun
|
||||
* Thomas Zajic
|
||||
* Andreas Schneider
|
||||
* Ben Winslow
|
||||
* Florian Riepler
|
||||
* Mike Mestnik
|
||||
* Luigi Auriemma
|
||||
* Alexander Hambalgo <balgo@users.sf.net>
|
||||
* Ozkan Sezer <sezero@users.sf.net>
|
||||
* Jorge Hodge <jhodge@users.sf.net>
|
||||
* Steffen Pankratz <krat00@users.sf.net>
|
||||
* Thomas Zajic <zlatk0@users.sf.net>
|
||||
* Jason Santos
|
||||
* Matze Braun
|
||||
* Philipp Thomasi
|
||||
* Andreas Schneider
|
||||
* Ben Winslow
|
||||
* Florian Riepler
|
||||
* Mike Mestnik
|
||||
* Simon Philips
|
||||
* Luigi Auriemma
|
||||
|
||||
|
||||
Translators
|
||||
-----------
|
||||
|
||||
* Dan Korostelev <dan@ats.energo.ru>
|
||||
* Michel Briand <michelbriand@free.fr>
|
||||
* François Perichon
|
||||
* Sami Laitinen
|
||||
* Miłosz Kosobucki
|
||||
* Morten Brix Pedersen
|
||||
- Jordi Mallach <jordi@debian.org>
|
||||
- Morten Brix Pedersen <morten@wtf.dk>
|
||||
- Sami Laitinen <azmotus@gmail.com>
|
||||
- Thomas Debesse <xqf@illwieckz.net>
|
||||
- Michel Briand <michelbriand@free.fr>
|
||||
- Ludwig Nussel <ludwig.nussel@suse.de>
|
||||
- Miłosz Kosobucki <mikomek@poczta.onet.pl>
|
||||
- Artem Vorotnikov <artem@vorotnikov.me>
|
||||
- Dan Korostelev <dan@ats.energo.ru>
|
||||
- François Perichon
|
||||
|
||||
Special thanks (reports, review, ideas, help…)
|
||||
----------------------------------------------
|
||||
|
||||
* Chris Vine <chris@cvine.freeserve.co.uk>
|
||||
* Tomasz Kalkosiński
|
||||
* Timothée Besset
|
||||
* Simon Philips
|
||||
* Wiesław Młynarski
|
||||
* Gonzalo Nemmi
|
||||
* Julien Langer
|
||||
* Ruediger Meier
|
||||
* Mike Frysinger
|
||||
* Michael Prager
|
||||
* Pierre Pronchery
|
||||
* Roerich
|
||||
* Kracho
|
||||
* Despair
|
||||
* Esa
|
||||
* cjay
|
||||
See the Wiki page for more information: https://github.com/XQF/xqf/wiki/Authors
|
||||
|
||||
253
GUIDELINES.md
253
GUIDELINES.md
@ -1,253 +0,0 @@
|
||||
GUIDELINES
|
||||
==========
|
||||
|
||||
Contribution
|
||||
------------
|
||||
|
||||
The best way to contribute is to fork this project and to request pulls.
|
||||
|
||||
|
||||
Coding guidelines
|
||||
-----------------
|
||||
|
||||
**Indentation**
|
||||
|
||||
Please use tabulations to indent your code, and white spaces to draw ascii art.
|
||||
|
||||
It means that if you want to align something to the left you must use tabulation, and if you want to aligne something to the right you must use white space.
|
||||
|
||||
Please _never_ mixes tabulations and white spaces for indentation.
|
||||
|
||||
_Good:_
|
||||
|
||||
```
|
||||
void function (void) {
|
||||
⇨gint integer;␣␣␣␣/* some comment
|
||||
⇨gchar character;␣␣* here */
|
||||
|
||||
⇨while (test) {
|
||||
⇨ ⇨do_something();
|
||||
⇨}
|
||||
}
|
||||
```
|
||||
|
||||
_Bad:_
|
||||
|
||||
```
|
||||
void function (void) {
|
||||
␣␣gint integer; ⇨ ⇨/* some comment
|
||||
␣␣gchar character;␣␣* here */
|
||||
|
||||
␣␣while (test) {
|
||||
⇨ ⇨do_something();
|
||||
␣␣}
|
||||
}
|
||||
```
|
||||
|
||||
**Comments**
|
||||
|
||||
CPlusPlus-like comments beginning with ``//`` are tolerated.
|
||||
|
||||
_Good:_
|
||||
|
||||
```c
|
||||
/* This is a comment,
|
||||
* you see?
|
||||
*/
|
||||
|
||||
// This is another comment.
|
||||
```
|
||||
|
||||
**Braces**
|
||||
|
||||
Please put the opening left brace at the end of the previous line.
|
||||
Never write a ``for``, ``while``, ``if``, and ``else`` block without braces.
|
||||
Never write a ``for``, ``while``, ``if``, ``else`` block in only one line.
|
||||
If a for statement has an empty block, please write a block with a comment in the empty block.
|
||||
|
||||
_Good:_
|
||||
|
||||
```c
|
||||
void function (void) {
|
||||
gint it;
|
||||
|
||||
if (test) {
|
||||
do_something();
|
||||
}
|
||||
else if (another_test) {
|
||||
do_somethingelse();
|
||||
}
|
||||
else {
|
||||
return;
|
||||
}
|
||||
for (it = 0; do(&it); it++) {
|
||||
// 'for' does it
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
_Bad:_
|
||||
|
||||
```c
|
||||
void function (void)
|
||||
{
|
||||
gint it;
|
||||
|
||||
if (test)
|
||||
{
|
||||
do_something();
|
||||
}
|
||||
else if (another_test)
|
||||
do_somethingelse();
|
||||
else { return };
|
||||
|
||||
for (it = 0; do(&it); it++);
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
_Very very bad:_
|
||||
|
||||
```c
|
||||
for (i = 0; i < max; i++)
|
||||
if (i == j)
|
||||
return i;
|
||||
```
|
||||
|
||||
**Parenthesis and spacing**
|
||||
|
||||
Please leave a white space before ``if``, ``for`` and ``while`` and the opening left parenthesis.
|
||||
Please do not write white space between a function name and the opening left parenthesis, unless this is a declaration.
|
||||
Please do not put extra white space inside parenthesis.
|
||||
|
||||
Please write a white space to the left and the right of an operator. There is an exception for ``++`` and ``--``.
|
||||
|
||||
_Good:_
|
||||
|
||||
```c
|
||||
void function (gint it) {
|
||||
gpointer n = NULL;
|
||||
gint m = 0;
|
||||
gint p;
|
||||
|
||||
if (this && that) {
|
||||
do(it);
|
||||
}
|
||||
else if (i < j) {
|
||||
let(it);
|
||||
}
|
||||
|
||||
n = f(it)->well;
|
||||
m = 5 + 2;
|
||||
p++;
|
||||
}
|
||||
```
|
||||
|
||||
_Bad:_
|
||||
|
||||
```c
|
||||
void function (gint it) {
|
||||
gpointer n=NULL;
|
||||
gint m=0;
|
||||
gint p;
|
||||
|
||||
if(this && that) {
|
||||
do (it);
|
||||
}
|
||||
else if (i<j) {
|
||||
let( it );
|
||||
}
|
||||
|
||||
n=f (it)->well;
|
||||
m = 5+2;
|
||||
p++;
|
||||
}
|
||||
```
|
||||
|
||||
**Commas, semicolons and spacing**
|
||||
|
||||
Please leave white space before a comma or a semicolon, but please no write any white spaces before them.
|
||||
|
||||
_Good:_
|
||||
|
||||
```
|
||||
for (i = 0; i < max; i++ {
|
||||
function(i, j, k);
|
||||
}
|
||||
```
|
||||
|
||||
_Bad:_
|
||||
|
||||
```
|
||||
for (i = 0 ;i < max ;i++ {
|
||||
function(i,j,k);
|
||||
}
|
||||
```
|
||||
|
||||
**Incrementation**
|
||||
|
||||
Please write different lines for incrementation and affectation.
|
||||
|
||||
_Good:_
|
||||
|
||||
```c
|
||||
it++;
|
||||
do(it);
|
||||
|
||||
do(more);
|
||||
more--;
|
||||
|
||||
c = a;
|
||||
a += b;
|
||||
```
|
||||
|
||||
_Bad:_
|
||||
|
||||
```c
|
||||
do(++it);
|
||||
|
||||
do(more--);
|
||||
|
||||
c = a += b;
|
||||
```
|
||||
|
||||
_Very very bad:_
|
||||
|
||||
```c
|
||||
*dst++ = *src++;
|
||||
```
|
||||
|
||||
This previous line was real and has corrupted memory during 14 years.
|
||||
|
||||
|
||||
**Splitted lines**
|
||||
|
||||
Please do not split lines if they are not too long to be splitted two times or more (three lines or more).
|
||||
|
||||
_Good:_
|
||||
|
||||
```c
|
||||
long_function_name(something very long, and this,
|
||||
and that, and this is very very longer than long,
|
||||
and this is another very long line);
|
||||
|
||||
this_long_variable = "has a not a very very long value";
|
||||
```
|
||||
|
||||
_Bad:_
|
||||
|
||||
```c
|
||||
function_name(
|
||||
something not very long);
|
||||
|
||||
this_long_variable =
|
||||
"has not a very very long value";
|
||||
```
|
||||
|
||||
**Good to know**
|
||||
|
||||
All the bad examples presented here were real before a large clean-up was done.
|
||||
|
||||
All the code does not currently follow these guidelines, if you change something in the code and if this part does not follow these guidelines, do not hesitate to fix the appearance too.
|
||||
|
||||
Rules are not absolute.
|
||||
63
README.md
63
README.md
@ -6,63 +6,76 @@ XQF
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
XQF is a server browser and launcher for games using [id Tech engines](http://en.wikipedia.org/wiki/Id_Tech), [Unreal engines](http://en.wikipedia.org/wiki/Unreal_Engine) and derivatives. It uses the [GTK+](http://www.gtk.org/) 2 toolkit.
|
||||
XQF is a server browser and launcher for games using id Tech engines, Unreal engines and derivatives. XQF is a front-end to QStat and uses the GTK+ 2 toolkit. See the Wiki for more information: https://github.com/XQF/xqf/wiki
|
||||
|
||||
XQF is a front-end to [QStat](http://qstat.sourceforge.net/), a program by Steve Jankowski.
|
||||
|
||||
See the file [NEWS.md](NEWS.md) and the [ChangeLog](ChangeLog) for updated information.
|
||||
To learn more about what's new in XQF, please read the file [NEWS.md](NEWS.md) and the [ChangeLog](ChangeLog).
|
||||
|
||||
|
||||
BUILD / INSTALLATION / USAGE
|
||||
----------------------------
|
||||
DOWNLOADS
|
||||
---------
|
||||
|
||||
See the Wiki page: https://github.com/XQF/xqf/wiki/Downloads
|
||||
|
||||
|
||||
INSTALLATION
|
||||
------------
|
||||
|
||||
[](https://travis-ci.org/XQF/xqf)
|
||||
|
||||
1. ``git clone https://github.com/XQF/xqf.git``; ``cd xqf``
|
||||
2. ``./autogen.sh``
|
||||
3. ``./configure`` (with Debian or Ubuntu, add ``--with-qstat=quakestat --prefix=/usr``)
|
||||
4. ``make``
|
||||
5. ``make install`` (or ``fakeroot checkinstall --fstrans=yes``)
|
||||
6. ``xqf``
|
||||
```sh
|
||||
git clone https://github.com/XQF/xqf.git
|
||||
cd xqf
|
||||
./autogen.sh
|
||||
./configure
|
||||
make
|
||||
make install
|
||||
xqf
|
||||
```
|
||||
|
||||
Please see the ``docs/xqfdocs.html`` file for more information. Warning, this page is not up to date!
|
||||
On Debian or Ubuntu, use ``./configure --with-qstat=quakestat --prefix=/usr``.
|
||||
|
||||
See the Wiki page for more information: https://github.com/XQF/xqf/wiki/How-to-build
|
||||
|
||||
|
||||
AVAILABILITY / PLACES TO BE
|
||||
---------------------------
|
||||
LINKS
|
||||
-----
|
||||
|
||||
* Current home page: [linuxgames.com/xqf](http://www.linuxgames.com/xqf/)
|
||||
* XQF Wiki: [github.com/XQF/xqf/wiki](https://github.com/XQF/xqf/wiki)
|
||||
* Mail list: [sf.net/p/xqf/mailman/](https://sourceforge.net/p/xqf/mailman/)
|
||||
* IRC Channel: [#xqf@Freenode](irc://irc.freenode.net/xqf)
|
||||
* IRC Channel: [#xqf@Freenode](irc://chat.freenode.net/xqf)
|
||||
* XMPP Conference: [xqf@conference.jabber.ru](xmpp://xqf@conference.jabber.ru?join)
|
||||
* Source code repository: [github.com/XQF/xqf](https://github.com/XQF/xqf/) (up to date Git repository)
|
||||
* Online translation tool: [transifex.com/projects/p/xqf](https://www.transifex.com/projects/p/xqf/)
|
||||
* Continuous integration tool: [travis-ci.org/XQF/xqf](https://travis-ci.org/XQF/xqf)
|
||||
* Historical archives: [sf.net/p/xqf](https://sourceforge.net/projects/xqf/) (previously published files, old SVN repository, and old ticket list)
|
||||
* QStat, the tool on which XQF is based: [github.com/multiplay/qstat](https://github.com/multiplay/qstat)
|
||||
|
||||
|
||||
HOW TO CONTRIBUTE
|
||||
-----------------
|
||||
|
||||
The best way to contribute code is to fork this project, please read the [GUIDELINES.md](GUIDELINES.md) for further information.
|
||||
To contribute translation, the best way is to do it on Transifex.
|
||||
The best way to contribute code is to fork this project, to contribute translation please visit our Transifex project. See the Wiki page for more information: https://github.com/XQF/xqf/wiki/How-to-contribute
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
---------
|
||||
|
||||
XQF is Copyright © 1998-2000 Roman Pozlevich.
|
||||
See the file [AUTHORS.md](AUTHORS.md) for contributors.
|
||||
See the wiki page for contributors: https://github.com/XQF/xqf/wiki/Contributors
|
||||
|
||||
Copying is allowed under the terms of GNU General Public License.
|
||||
Copying is allowed under the terms of the GNU General Public License.
|
||||
See the file [COPYING](COPYING) for more details.
|
||||
|
||||
|
||||
HISTORY
|
||||
-------
|
||||
|
||||
2013-2015 Thomas Debesse <xqf@illwieckz.net>
|
||||
2001-2014 Jordi Mallach <jordi@debian.org>
|
||||
2001-2010 Ludwig Nussel <ludwig.nussel@suse.de>
|
||||
2000-2003 Alex Burger <alex_b@users.sf.net>
|
||||
XQF was originally written by Roman Pozlevich in 1998. It has been maintained and improved by a devoted team over the years with following major developers:
|
||||
|
||||
1998-2000 Roman Pozlevich <roma@botik.ru>
|
||||
2000-2002 Bill Adams <bill@evilbill.org>
|
||||
1998-2000 Roman Pozlevich <roma@botik.ru>
|
||||
2000-2003 Alex Burger <alex_b@users.sf.net>
|
||||
2001-2010 Ludwig Nussel <ludwig.nussel@suse.de>
|
||||
2001-2014 Jordi Mallach <jordi@debian.org>
|
||||
2013-2015 Thomas Debesse <xqf@illwieckz.net>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user