Cleaned up the introduction page.

This commit is contained in:
Relintai 2024-04-20 17:04:57 +02:00
parent 825f622aa5
commit c66c3708ca

View File

@ -16,15 +16,10 @@ This page gives a broad presentation of the engine and of the contents
of this documentation, so that you know where to start if you are a beginner or of this documentation, so that you know where to start if you are a beginner or
where to look if you need info on a specific feature. where to look if you need info on a specific feature.
## Before you start Pandemonium Engine is a fork of the [Godot Engine](https://godotengine.org/) (specifically the
[3.x](https://github.com/godotengine/godot/commits/3.x) branch). With heavy modifications.
The `Tutorials and resources ( doc_community_tutorials )` page lists Even though lots of things have been changed, most tutorials for godot should work with minimal tweaks.
video tutorials contributed by the community. If you prefer video to text,
those may be worth a look.
In case you have trouble with one of the tutorials or your project,
you can find help on the various `Community channels ( doc_community_channels )`,
especially the Pandemonium Discord community, Q&A, and IRC.
## About Pandemonium Engine ## About Pandemonium Engine
@ -43,31 +38,30 @@ if you need a quick writeup about Pandemonium Engine.
license. No strings attached, no royalties, nothing. Users' games are license. No strings attached, no royalties, nothing. Users' games are
theirs, down to the last line of engine code. Pandemonium's development is fully theirs, down to the last line of engine code. Pandemonium's development is fully
independent and community-driven, empowering users to help shape their independent and community-driven, empowering users to help shape their
engine to match their expectations. It is supported by the `Software engine to match their expectations. It is supported by the
Freedom Conservancy ( https://sfconservancy.org )` not-for-profit. [Software Freedom Conservancy](https://sfconservancy.org) not-for-profit.
For a more in-depth view of the engine, you are encouraged to read this For a more in-depth view of the engine, you are encouraged to read this
documentation further, especially the `Step by step documentation further, especially the
( toc-learn-step_by_step )` tutorial. [step by step](../index.html#tutorials/stepbystep) tutorial.
## About the documentation ## About the documentation
This documentation is continuously written, corrected, edited, and revamped by This documentation is continuously worked on. It is edited via text files in the
members of the Pandemonium Engine community. It is edited via text files in the markdown language and then compiled into a static website / offline document using
`reStructuredText ( http://www.sphinx-doc.org/en/stable/rest.html )` markup a simple python script in the repository's
language and then compiled into a static website/offline document using the [_tools](https://github.com/Relintai/pandemonium_engine_docs/tree/master/_tools) folder.
open source `Sphinx ( http://www.sphinx-doc.org )` and `ReadTheDocs
( https://readthedocs.org/ )` tools. It's using [markdeep](https://casual-effects.com/markdeep/) for rendering it's final html output.
Note: Note:
You can contribute to Pandemonium's documentation by opening issue tickets
or sending patches via pull requests on its GitHub - You can contribute to Pandemonium's documentation by opening issue tickets
`source repository ( https://github.com/Relintai/pandemonium_engine-docs )`, or or sending patches via pull requests on its GitHub
translating it into your language on `Hosted Weblate [source repository](https://github.com/Relintai/pandemonium_engine_docs).
( https://hosted.weblate.org/projects/pandemonium-engine/pandemonium-docs/ )`.
All the contents are under the permissive Creative Commons Attribution 3.0 All the contents are under the permissive Creative Commons Attribution 3.0
(`CC-BY 3.0 ( https://creativecommons.org/licenses/by/3.0/ )`) license, with [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/) license, with
attribution to "Péter Magyar and the Pandemonium community, and Juan Linietsky, Ariel Manzur and the Godot community". attribution to "Péter Magyar and the Pandemonium community, and Juan Linietsky, Ariel Manzur and the Godot community".
## Organization of the documentation ## Organization of the documentation
@ -76,31 +70,26 @@ This documentation is organized in five sections with an impressively
unbalanced distribution of contents but the way it is split up should be unbalanced distribution of contents but the way it is split up should be
relatively intuitive: relatively intuitive:
- The `sec-general` section contains this introduction as well as - The [About](../index.html#about) section contains this introduction as well as
information about the engine, its history, its licensing, authors, etc. It information about the engine, its history, its licensing, authors, etc. It
also contains the `doc_faq`. also contains the [FAQ](02_faq.md.html).
- The `sec-learn` section is the *raison d'être* of this - The [Tutorials](../index.html#tutorials) section can be read as needed,
documentation, as it contains all the necessary information on using the
engine to make games. It starts with the `Step by step
( toc-learn-step_by_step )` tutorial which should be the entry point for all
new users.
- The `sec-tutorials` section can be read as needed,
in any order. It contains feature-specific tutorials and documentation. in any order. It contains feature-specific tutorials and documentation.
- The `sec-devel` section is intended for advanced users and contributors - The [Usage](../index.html#usage) section is the *raison d'être* of this
documentation, as it contains all the necessary information on using the
engine to make games.
- [Modules](../index.html#modules). Some of the engine's functionality is in modules that can be turned on or off
when compiling. This section contains information about these.
- The [Engine Development](../index.html#enginedevelopment) section is intended for advanced users and contributors
to the engine development, with information on compiling the engine, to the engine development, with information on compiling the engine,
developing C++ modules or editor plugins. developing C++ modules or editor plugins.
- The `sec-community` section gives information related to contributing to - The [Community](../index.html#community) section gives information related to contributing to
engine development and the life of its community, e.g. how to report bugs, engine development and the life of its community, e.g. how to report bugs,
help with the documentation, etc. It also points to various community channels help with the documentation, etc. It also points to various community channels
like IRC and Discord and contains a list of recommended third-party tutorials like IRC and Discord and contains a list of recommended third-party tutorials
outside of this documentation. outside of this documentation.
- Finally, the `sec-class-ref` is the documentation of the Pandemonium API,
which is also available directly within the engine's script editor. It is
generated automatically from a file in the main source repository, therefore
the generated files of the documentation are not meant to be modified. See
`doc_updating_the_class_reference` for details.
In addition to this documentation you may also want to take a look at the In addition to this documentation you may also want to take a look at the
various `Pandemonium demo projects ( https://github.com/Relintai/pandemonium_engine-demo-projects )`. various [Pandemonium demo projects](https://github.com/Relintai/pandemonium_demo_projects).
Have fun reading and making games with Pandemonium Engine! Have fun reading and making games with Pandemonium Engine!