README.md
author unc0rr
Wed, 06 Dec 2017 23:46:17 +0100
changeset 12852 bd35cb2302b3
parent 12752 0e425574bd5f
child 12994 4d4b2fb88e50
permissions -rw-r--r--
Quick dirty fix for building
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     1
Hedgewars - a turn-based strategy game
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     2
======================================
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     3
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     4
Description
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     5
-----------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     6
This is the funniest and most addictive game you'll ever play—hilarious fun
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     7
that you can enjoy anywhere, anytime. **Hedgewars** is a **turn-based strategy
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     8
game** but the real buzz is from watching the **devastation caused by those
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     9
pesky hedgehogs** with those fantastic weapons—sneaky little blighters with a
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    10
bad attitude!
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    11
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    12
Each player controls a **team of up to 8 hedgehogs**. During the course of
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    13
the game, players take turns with one of their hedgehogs. They then use
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    14
whatever tools and weapons are available to **attack and kill the opponents'
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    15
hedgehogs**, thereby winning the game. Hedgehogs may move around the terrain
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    16
in a variety of ways, normally by walking and jumping but also by using
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    17
particular tools such as the rope or parachute, to move to otherwise
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    18
inaccessible areas. Each **turn is time-limited** to ensure that players do
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    19
not hold up the game with excessive thinking or moving.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    20
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    21
A large **variety of tools and weapons** are available for players during
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    22
the game. Hedgewars features the standard artillery-genre classics (such as
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    23
grenade, cluster bomb, bazooka, shotgun), but also boasts a host of other
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    24
weapons quite unique to it alone.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    25
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    26
Most weapons, when used, cause **explosions that deform the terrain**,
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    27
removing circular chunks. Hedgehogs can die by drowning, being thrown off
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    28
either side of the arena, or when their health is reduced to zero.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    29
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    30
Getting started
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    31
---------------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    32
For complete beginners we recommend to start with the the first 2 or 3
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    33
missions of the campaign “A Classic Fairytale” in the singleplayer menu.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    34
It explains the basic controls and gameplay.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    35
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    36
Note that Hedgewars doesn't have a *complete* tutorial yet, but it is
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    37
planned to create one in future versions.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    38
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    39
In-depth information about the game can be found online:
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    40
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    41
* <https://hedgewars.org/start>: Getting Started
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    42
* <https://hedgewars.org/wiki.html>: Hedgewars Wiki
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    43
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    44
Default controls (excerpt)
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    45
--------------------------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    46
The most important default controls are:
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    47
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    48
* Cursor keys: Walk and aim
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    49
* Mouse: Move camera
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    50
* Right mouse button: Open ammo menu
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    51
* Left mouse button: Select target or weapon
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    52
* Space bar: Shoot
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    53
* Left shift: Precise
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    54
* Left shift + Up/Down: Precise aiming
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    55
* Enter: Jump
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    56
* Backspace: High jump
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    57
* Backspace ×2: Backjump
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    58
* Tab: Switch hedgehog (after activating the utility)
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    59
* 1-5: Set weapon timer
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    60
* F1-F10: Weapon shortcuts
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    61
* P: Pause (also shows mission panel)
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    62
* Esc: Quit with prompt (also shows mission panel)
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    63
* T: Chat
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    64
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    65
For the full list, go to the Hedgewars settings. Also read the weapon tooltips
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    66
for weapon-specific controls.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    67
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    68
### Special controls
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    69
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    70
These are lesser-known controls of Hedgewars, they are based on your
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    71
configured controls:
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    72
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    73
* Confirm: Team chat (if not confirming quit)
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    74
* Hold down Precise: Prevent slipping on ice
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    75
* Precise + Left/Right: Turn around
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    76
* Precise + Toggle team bars: Change hedgehog tabs
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    77
* Precise + Toggle team bars + Switch: Toggle HUD
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    78
* Precise + Screenshot: Save current map + mask in Screenshot directory
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    79
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    80
Installation instructions
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    81
-------------------------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    82
See the `INSTALL.md` file.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    83
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    84
Or see our wiki at <https://hedgewars.org/kb/BuildingHedgewars>.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    85
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    86
Source code
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    87
-----------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    88
Our main repository is located at <https://hg.hedgewars.org/hedgewars/> using
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    89
Mercurial as DVCS. A Git repository is also available (mirrored daily)
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    90
at <https://github.com/hedgewars/hw>.
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
    91
11357
89fd907ccdec README.md: Add a travis badge
koda
parents: 11319
diff changeset
    92
[![Build Status](https://travis-ci.org/hedgewars/hw.svg)](https://travis-ci.org/hedgewars/hw)
89fd907ccdec README.md: Add a travis badge
koda
parents: 11319
diff changeset
    93
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    94
Contribute
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    95
----------
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
    96
If you see a bug or have any suggestion please use the official bug tracker at
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    97
<https://hedgewars.org/bugs> or the integrated feedback button.
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
    98
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
    99
If you want to help or get to know the sources better you can do that with some
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   100
easy tasks from <https://hedgewars.org/kb/TODO>. We also have an extensive API
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   101
in Lua to customize your adventures. See our wiki at
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   102
<https://hedgewars.org/kb/LuaAPI>.
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   103
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   104
If you know your way through the code feel free to send a patch or open a pull
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   105
request. The best Lua scripts get released in the official DLC page and later
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   106
integrated in the next version.
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   107
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   108
Licence and credits
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   109
-------------------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   110
This game is free software (“free” as in “freedom”). Source code is
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   111
distributed under the terms of the GNU General Public Licence version 2;
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   112
images and sounds are distributed under the terms of the GNU Free Documentation
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   113
Licence version 1.2. See the `COPYING` file for the full text of the licenses.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   114
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   115
Copyright 2004-2015 Andrey Korotaev <unC0Rr@gmail.com> and others.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   116
See `QTfrontend/res/html/about.html` and `CREDITS` for a more complete list of
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   117
authors.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   118
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   119
Contact
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   120
-------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   121
* Homepage        - https://hedgewars.org/
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   122
* IRC channel     - irc://irc.freenode.net/hedgewars
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   123
* Community forum - https://hedgewars.org/forum
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   124
* Mailing list    - https://mail.gna.org/listinfo/hedgewars-dev
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   125