Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# autotools build method
/autom4te.cache/
/builds/autoconf/
!/builds/autoconf/config.rpath
!/builds/autoconf/m4/m4_ax_pkg_check_modules.m4
/liblcf-*/
/tests/*.log
Expand Down Expand Up @@ -39,10 +38,6 @@ CMakeFiles/
!/builds/cmake/Modules/Find*.cmake
/builds/cmake/lib/

# qt build method
/builds/qt/
!/builds/qt/liblcf.pro

# doxygen generated files
/doc/

Expand Down
7 changes: 0 additions & 7 deletions AUTHORS

This file was deleted.

7 changes: 7 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
liblcf authors
==============

* Alejandro Marzini (vgvgf)
* Gabriel Kind (Ghabry)
* Glynn Clements (glynnc)
* Paulo "Zhek" Vizcaino (paulo_v)
4 changes: 2 additions & 2 deletions Makefile.am
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
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

Expand Down Expand Up @@ -112,12 +112,12 @@ pkginclude_HEADERS = \
src/data.h \
src/ini.h \
src/inireader.h \
src/lcf_options.h \
src/ldb_reader.h \
src/lmt_reader.h \
src/lmu_reader.h \
src/lsd_reader.h \
src/reader_lcf.h \
src/reader_options.h \
src/reader_struct.h \
src/reader_types.h \
src/reader_util.h \
Expand Down
100 changes: 0 additions & 100 deletions README

This file was deleted.

84 changes: 84 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# 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.1.tar.xz # unpack the tarball
cd liblcf-0.5.1 # 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.
Loading