Convert readme file to Markdown format

1 files changed, 50 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..763af37
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# HUD bars
+
+## Description
+This mod changes the HUD of Minetest. It replaces the default health and breath
+symbols by horizontal colored bars with text showing the number.
+
+Furthermore, it enables other mods to add their own custom bars to the HUD,
+this mod will place them accordingly.
+
+**Important**: Keep in mind if running a server with this mod, that the custom
+position should be displayed correctly on every screen size.
+
+## Current version
+The current version is 1.2.1.
+
+This software uses [semantic versioning](http://semver.org), as defined by version 2.0.0 of the SemVer
+standard.
+
+## Settings
+This mod can be configured quite a bit. You can change HUD bar appearance, offsets, ordering, and more.
+Use the advanced settings menu in Minetest for detailed configuration.
+
+## API
+The API is used to add your own custom HUD bars.
+Documentation for the API of this mod can be found in `API.md`.
+
+## Legal
+### License of source code
+Author: Wuzzy (2015)
+
+This mod was forked from the “Better HUD” [hud] mod by BlockMen.
+
+This program is free software. It comes without any warranty, to
+the extent permitted by applicable law. You can redistribute it
+and/or modify it under the terms of the Do What The Fuck You Want
+To Public License (WTFPL), version 2, as published by Sam Hocevar.
+
+### Licenses of textures
+
+* `hudbars_icon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
+* `hudbars_bgicon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
+* `hudbars_icon_breath.png`—kaeza (WTFPL), modified by BlockMen
+* `hudbars_bar_health.png`—Wuzzy (WTFPL)
+* `hudbars_bar_breath.png`—Wuzzy (WTFPL)
+* `hudbars_bar_background.png`—Wuzzy (WTFPL)
+
+### License references
+
+* [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)
+* [WTFPL](http://sam.zoy.org/wtfpl/COPYING)
\ No newline at end of file