Mercurial > molko
annotate README.md @ 435:556c8e2ff995
misc: move tools/* in /
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 16 Oct 2022 08:31:01 +0200 |
parents | 2862526f1fc9 |
children | e1fa1b867281 |
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 |
414
6947c1fefe5c
misc: extreme cleanup
David Demelier <markand@malikania.fr>
parents:
366
diff
changeset
|
4 The Molko's Engine is a C and framework to write 2D RPG games in a portable |
6947c1fefe5c
misc: extreme cleanup
David Demelier <markand@malikania.fr>
parents:
366
diff
changeset
|
5 manner. 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 |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
9 - Written in C99, |
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 |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
19 Use `mkdocs serve` inside the **doc** directory to see the user and developer |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
20 documentation. |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 Author |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 ------ |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
25 Molko's Engine was written by David Demelier <markand@malikania.fr>. |