Markdownify READMEs and AUTHORS files
DELETE
AUTHORS
-liblcf authors:
-
-Alejandro Marzini (vgvgf)
-Gabriel Kind (ghabry)
-Glynn Clements (glynnc)
-Paulo "Zhek" Vizcaino (paulo_v)
-

ADD
AUTHORS.md
+liblcf authors
+==============
+
+* Alejandro Marzini (vgvgf)
+* Gabriel Kind (Ghabry)
+* Glynn Clements (glynnc)
+* Paulo "Zhek" Vizcaino (paulo_v)

MODIFY
Makefile.am
Makefile.am
ACLOCAL_AMFLAGS = --install -I builds/autoconf/m4
-EXTRA_DIST = builds generator
+EXTRA_DIST = AUTHORS.md README.md builds generator
pkgconfigdir = ${libdir}/pkgconfig
pkgconfig_DATA = builds/liblcf.pc

DELETE
README
-liblcf
-======
-
-liblcf is a library to handle RPG Maker 2000 and 2003 game data.
-It can read and write LCF and XML files.
-
-liblcf is part of the EasyRPG Project. More information is available
-at the project website:
-
- https://easyrpg.org/
-
-
-Documentation
--------------
-
-Documentation is available at the documentation wiki:
-
- https://wiki.easyrpg.org/
-
-
-Requirements
-------------
-
-Expat for XML reading support.
-ICU for character encoding detection and conversion.
-
-
-Source code
------------
-
-liblcf development is hosted by GitHub.
-Project files are available in Git repositories.
-
- https://github.com/EasyRPG/liblcf
-
-
-Building
---------
-
-* Makefile method:
-
- Building requirements:
-
- pkg-config
- make
-
- 1. Unpack the tarball with:
-
- tar xf liblcf-0.5.0.tar.xz
-
- 2. Enter in the package directory with:
-
- cd liblcf-0.5.0
-
- 3. Compile and install with:
-
- ./configure --prefix /usr
- make
- sudo make install
-
-
- Specific building requirements from source tree (Git):
-
- autoconf >= 2.69
- automake >= 1.11.4
- libtool
-
- To generate the "configure" script, run:
-
- autoreconf -i
-
- Then follow the "3. Compile with:" section.
-
-
- Read more detailed instructions at:
-
- https://wiki.easyrpg.org/development/compiling/liblcf/autotools
- https://wiki.easyrpg.org/development/compiling/liblcf/cmake
-
-
-Bug reporting
--------------
-
-Available options:
-
-* File an issue at https://github.com/EasyRPG/liblcf/issues
-
-* Open a thread at https://community.easyrpg.org/
-
-* Chat with us via IRC: #easyrpg at irc.freenode.net
-
-
-License
--------
-
-liblcf is Free/Libre Open Source Software, released under the MIT License.
-See the file COPYING for copying conditions.
-
-liblcf code includes a copy of Boost Preprocessor Cat and Stringize
-(Boost Software License 1.0) and a copy of inih (New BSD license).
-See the source code comment headers for license details.

ADD
README.md
+# liblcf
+
+liblcf is a library to handle RPG Maker 2000 and 2003 game data.
+It can read and write LCF and XML files.
+
+liblcf is part of the EasyRPG Project. More information is available
+at the project website: https://easyrpg.org/
+
+
+## Documentation
+
+Documentation is available at the documentation wiki: https://wiki.easyrpg.org
+
+
+## Requirements
+
+Expat for XML reading support.
+ICU for character encoding detection and conversion.
+
+
+## Source code
+
+liblcf development is hosted by GitHub, project files are available
+in this git repository:
+
+https://github.com/EasyRPG/liblcf
+
+Released versions are also available at our Download Archive:
+
+https://easyrpg.org/downloads/
+
+
+## Building
+
+### Autotools Makefile method:
+
+Building requirements:
+
+- pkg-config
+- GNU make
+
+Step-by-step instructions:
+
+ tar xf liblcf-0.5.0.tar.xz # unpack the tarball
+ cd liblcf-0.5.0 # enter in the package directory
+ ./configure --prefix /usr # find libraries, set options
+ make # compile the library
+ sudo make install # install system-wide
+
+Additional building requirements when using the source tree (git):
+
+- autoconf >= 2.69
+- automake >= 1.11.4
+- libtool
+
+To generate the "configure" script, run before following the above section:
+
+ autoreconf -i
+
+Read more detailed instructions at:
+
+* https://wiki.easyrpg.org/development/compiling/liblcf/autotools
+* https://wiki.easyrpg.org/development/compiling/liblcf/cmake
+
+
+## Bug reporting
+
+Available options:
+
+* File an issue at https://github.com/EasyRPG/liblcf/issues
+* Open a thread at https://community.easyrpg.org/
+* Chat with us via IRC: #easyrpg at irc.freenode.net
+
+
+## License
+
+liblcf is Free/Libre Open Source Software, released under the MIT License.
+See the file COPYING for copying conditions.
+
+### 3rd party software
+
+liblcf code includes a copy of Boost Preprocessor Cat and Stringize
+(Boost Software License 1.0) and a copy of inih (New BSD license).
+See the source code comment headers for license details.

DELETE
generator/README
-liblcf source code generator
-============================
-
-Files in the generated subdirectory of src directory are regenerated
-automatically when running the generate.py script.
-
-These source code files are generated with the templates subfolder
-structure based on the csv subfolder data files.
-
-
-Requirements
-------------
-
-* Python interpreter version 2 or 3.
-
-* CSV files can be read with any text editor or (at your option) any
- spreadsheet editor.
-
-
-Usage
------
-
-1. Open one of the csv files in the csv subdirectory to edit or add new
- data then save file changes.
-
-2. Run the file generate.py from the generator folder.
-
-3. Add any new created .cpp and .h to project files if needed.
-
-4. Recompile liblcf.

ADD
generator/README.md
+# liblcf source code generator
+
+Files in the `generated` subdirectory of `src` directory are regenerated
+automatically when running the `generate.py` script.
+
+These source code files are generated with the `templates` subfolder
+structure based on the `csv` subfolder data files.
+
+
+## Requirements
+
+* Python interpreter version 2 or 3.
+* CSV files can be modified with any text editor or (at your option) any
+ spreadsheet editor.
+
+
+## Usage
+
+1. Open one of the .csv files in the `csv` subdirectory to edit or add new
+ data then save file changes.
+2. Run the script file `generate.py` from the `generator` folder.
+3. Add any newly created .cpp and .h files to project files if needed.
+4. Recompile liblcf.

Markdownify READMEs and AUTHORS files