Skip to content

Commit 29fa7c9

Browse files
committed
Markdownify READMEs and AUTHORS files
1 parent c461c82 commit 29fa7c9

7 files changed

Lines changed: 115 additions & 139 deletions

File tree

AUTHORS

Lines changed: 0 additions & 7 deletions
This file was deleted.

AUTHORS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
liblcf authors
2+
==============
3+
4+
* Alejandro Marzini (vgvgf)
5+
* Gabriel Kind (Ghabry)
6+
* Glynn Clements (glynnc)
7+
* Paulo "Zhek" Vizcaino (paulo_v)

Makefile.am

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
ACLOCAL_AMFLAGS = --install -I builds/autoconf/m4
2-
EXTRA_DIST = builds generator
2+
EXTRA_DIST = AUTHORS.md README.md builds generator
33
pkgconfigdir = ${libdir}/pkgconfig
44
pkgconfig_DATA = builds/liblcf.pc
55

README

Lines changed: 0 additions & 101 deletions
This file was deleted.

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# liblcf
2+
3+
liblcf is a library to handle RPG Maker 2000 and 2003 game data.
4+
It can read and write LCF and XML files.
5+
6+
liblcf is part of the EasyRPG Project. More information is available
7+
at the project website: https://easyrpg.org/
8+
9+
10+
## Documentation
11+
12+
Documentation is available at the documentation wiki: https://wiki.easyrpg.org
13+
14+
15+
## Requirements
16+
17+
Expat for XML reading support.
18+
ICU for character encoding detection and conversion.
19+
20+
21+
## Source code
22+
23+
liblcf development is hosted by GitHub, project files are available
24+
in this git repository:
25+
26+
https://github.com/EasyRPG/liblcf
27+
28+
Released versions are also available at our Download Archive:
29+
30+
https://easyrpg.org/downloads/
31+
32+
33+
## Building
34+
35+
### Autotools Makefile method:
36+
37+
Building requirements:
38+
39+
- pkg-config
40+
- GNU make
41+
42+
Step-by-step instructions:
43+
44+
tar xf liblcf-0.5.0.tar.xz # unpack the tarball
45+
cd liblcf-0.5.0 # enter in the package directory
46+
./configure --prefix /usr # find libraries, set options
47+
make # compile the library
48+
sudo make install # install system-wide
49+
50+
Additional building requirements when using the source tree (git):
51+
52+
- autoconf >= 2.69
53+
- automake >= 1.11.4
54+
- libtool
55+
56+
To generate the "configure" script, run before following the above section:
57+
58+
autoreconf -i
59+
60+
Read more detailed instructions at:
61+
62+
* https://wiki.easyrpg.org/development/compiling/liblcf/autotools
63+
* https://wiki.easyrpg.org/development/compiling/liblcf/cmake
64+
65+
66+
## Bug reporting
67+
68+
Available options:
69+
70+
* File an issue at https://github.com/EasyRPG/liblcf/issues
71+
* Open a thread at https://community.easyrpg.org/
72+
* Chat with us via IRC: #easyrpg at irc.freenode.net
73+
74+
75+
## License
76+
77+
liblcf is Free/Libre Open Source Software, released under the MIT License.
78+
See the file COPYING for copying conditions.
79+
80+
### 3rd party software
81+
82+
liblcf code includes a copy of Boost Preprocessor Cat and Stringize
83+
(Boost Software License 1.0) and a copy of inih (New BSD license).
84+
See the source code comment headers for license details.

generator/README

Lines changed: 0 additions & 30 deletions
This file was deleted.

generator/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# liblcf source code generator
2+
3+
Files in the `generated` subdirectory of `src` directory are regenerated
4+
automatically when running the `generate.py` script.
5+
6+
These source code files are generated with the `templates` subfolder
7+
structure based on the `csv` subfolder data files.
8+
9+
10+
## Requirements
11+
12+
* Python interpreter version 2 or 3.
13+
* CSV files can be modified with any text editor or (at your option) any
14+
spreadsheet editor.
15+
16+
17+
## Usage
18+
19+
1. Open one of the .csv files in the `csv` subdirectory to edit or add new
20+
data then save file changes.
21+
2. Run the script file `generate.py` from the `generator` folder.
22+
3. Add any newly created .cpp and .h files to project files if needed.
23+
4. Recompile liblcf.

0 commit comments

Comments
 (0)