Mercurial > molko
annotate README.md @ 646:7e1eb7f6c049 default tip @
misc: remove .clang
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 04 Feb 2024 15:24:37 +0100 |
parents | e070fdcc592b |
children |
rev | line source |
---|---|
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
1 Molko's Engine |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
2 ============== |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
3 |
594
e070fdcc592b
misc: various cleanups
David Demelier <markand@malikania.fr>
parents:
447
diff
changeset
|
4 The Molko's Engine is a C framework to write 2D RPG games in a portable manner. |
e070fdcc592b
misc: various cleanups
David Demelier <markand@malikania.fr>
parents:
447
diff
changeset
|
5 It is designed in mind to be flexible, simple and convenient to use. |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
6 |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
7 It has the following features: |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
8 |
594
e070fdcc592b
misc: various cleanups
David Demelier <markand@malikania.fr>
parents:
447
diff
changeset
|
9 - Written in C23, |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
10 - Portable (Windows, macOS and UNIX likes systems), |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
11 - Simple, flexible, |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
12 - Well documented, |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
13 - Virtual file system support. |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
14 - Can embed resources using `mlk-bcc`. |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
15 |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
16 Documentation |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
17 ------------- |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
18 |
594
e070fdcc592b
misc: various cleanups
David Demelier <markand@malikania.fr>
parents:
447
diff
changeset
|
19 Use the `doxygen` CMake target to build the documentation. |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 Author |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 ------ |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
24 Molko's Engine was written by David Demelier <markand@malikania.fr>. |