docs: Add a little layout to our documentation landing page.
There is more to do here, but this is a start. Give folk a better first-search experience for our wealth of documentation
This commit is contained in:
parent
5f2b58d93d
commit
4801c2a624
|
@ -2,7 +2,17 @@
|
||||||
|
|
||||||
{{page>start-shortcuts}}
|
{{page>start-shortcuts}}
|
||||||
|
|
||||||
==== Getting into Development ====
|
==== Enlightenment and EFL Developer Documentation ====
|
||||||
|
|
||||||
|
Enlightenment has developed from a window manager into a set of libraries
|
||||||
|
that support a large number of exciting applications.
|
||||||
|
Aimed primarily at slick graphical presentation and optimal runtime we
|
||||||
|
created the Enlightenment Foundation Libraries and have created the following
|
||||||
|
documentation to help everyone get involved - thanks for stopping by.
|
||||||
|
|
||||||
|
<columns 100% 33% - 33% ->
|
||||||
|
|
||||||
|
====Getting Started====
|
||||||
|
|
||||||
If you are going to use EFL, we encourage you to actually work with
|
If you are going to use EFL, we encourage you to actually work with
|
||||||
EFL from [[http://git.enlightenment.org|git]] mostly because it allows
|
EFL from [[http://git.enlightenment.org|git]] mostly because it allows
|
||||||
|
@ -26,49 +36,70 @@ course you can use stable packages for your distribution as well.
|
||||||
Go check the current available version of EFL on each distro/platform:
|
Go check the current available version of EFL on each distro/platform:
|
||||||
[[https://phab.enlightenment.org/w/packaging_status/|Table of current version of EFL]]
|
[[https://phab.enlightenment.org/w/packaging_status/|Table of current version of EFL]]
|
||||||
|
|
||||||
|
=== Working with Code ===
|
||||||
|
|
||||||
|
* [[docs/c/start|A basic primer on C]]
|
||||||
|
|
||||||
|
|
||||||
|
<newcolumn>
|
||||||
|
|
||||||
|
====EFL Documentation====
|
||||||
|
|
||||||
|
The EFL is currently undergoing a significant redesign to give a better
|
||||||
|
developer experience when building apps using our platform.
|
||||||
|
For now we recommend using the stable API and it's Bindings.
|
||||||
|
|
||||||
|
=== Working with EFL ===
|
||||||
|
|
||||||
|
* [[docs/efl/start|Get started with EFL]]
|
||||||
|
* [[docs/efl/advanced/start|Advanced EFL Topics]]
|
||||||
|
|
||||||
|
=== Stable API ===
|
||||||
|
|
||||||
|
* [[http://docs.enlightenment.org/efl/current|C (our main language)]]
|
||||||
|
* [[http://docs.enlightenment.org/python-efl/current|Python Bindings]]
|
||||||
|
|
||||||
|
=== Beta API using EO ===
|
||||||
|
|
||||||
|
* [[docs/efl/auto/reference|EFL EO API documentation (C)]]
|
||||||
|
|
||||||
|
|
||||||
|
<newcolumn>
|
||||||
|
|
||||||
|
====Contributing====
|
||||||
|
|
||||||
|
We are really excited that you would like to get involved in EFL and
|
||||||
|
Enlightenment development! If you followed the instructions in
|
||||||
|
"Getting Started" then you are most of the way to being part of the team.
|
||||||
|
To start with it's easiest to see which area you would like to work on and
|
||||||
|
get involved in bug reporting or fixing. From there you can get to know the
|
||||||
|
team, how we work, and earn a place on the team as a core developer :)
|
||||||
|
|
||||||
=== Feedback ===
|
=== Feedback ===
|
||||||
|
|
||||||
* [[debugging/report_bugs|Report bugs on Phabricator]]
|
* [[debugging/report_bugs|Report bugs on Phabricator]]
|
||||||
* [[contact/arcanist|Submit patch on Phabricator]]
|
* [[contact/arcanist|Submit patch on Phabricator]]
|
||||||
|
|
||||||
=== Working with EFL and Code ===
|
|
||||||
|
|
||||||
* [[docs/c/start|A basic primer on C]]
|
|
||||||
* [[docs/efl/start|Get started with EFL]]
|
|
||||||
* [[docs-efl-debug|Debugging (generic) - EFL and Enlightenment]]
|
|
||||||
* [[docs/efl/advanced/start|Advanced EFL Topics]]
|
|
||||||
|
|
||||||
=== Themes / Edje / EDC ===
|
|
||||||
|
|
||||||
A core part of Enlightenment and EFL is the design/theme abstraction layer. This is handled by the Edje library and a series of tools that can compile/package up theme files and compress them, decompile them, and even provide some GUI editors too.
|
|
||||||
|
|
||||||
* [[about-eflete|Eflete]] - GUI Theme design tool
|
|
||||||
* [[about-enventor|Enventor]] GUI Edje file design tool
|
|
||||||
* [[themes/start|Getting started]] with Edje and themes at the EDC file level
|
|
||||||
* [[themes/knob_example|Edje theme example]] A knob theme for the Elementary slider widget
|
|
||||||
|
|
||||||
=== Debugging ===
|
=== Debugging ===
|
||||||
|
|
||||||
|
* [[docs-efl-debug|Debugging (generic) - EFL and Enlightenment]]
|
||||||
* [[debugging/enlightenment_debugging|Enlightenment specific debugging]]
|
* [[debugging/enlightenment_debugging|Enlightenment specific debugging]]
|
||||||
* [[debugging/apps_efl_debugging|EFL application debugging]]
|
* [[debugging/apps_efl_debugging|EFL application debugging]]
|
||||||
* [[debugging/remote_debugging|Remote Debugging]]
|
* [[debugging/remote_debugging|Remote Debugging]]
|
||||||
|
|
||||||
=== Tutorials ===
|
|
||||||
|
|
||||||
* [[tutorial/basic_tutorial|Basic Tutorial]]
|
</columns>
|
||||||
* [[tutorial/genlist_tutorial|Genlist Tutorial]]
|
|
||||||
* [[tutorial/panes_tutorial|Panes Tutorial]]
|
|
||||||
* [[tutorial/form_tutorial|Form Tutorial]]
|
|
||||||
* [[tutorial/menu_tutorial|Menu Tutorial]]
|
|
||||||
* [[tutorial/naviframe_tutorial|Naviframe Tutorial]]
|
|
||||||
* [[tutorial/popup_tutorial|Popup Tutorial]]
|
|
||||||
* [[tutorial/gl_2d_tutorial|GL 2D Tutorial]]
|
|
||||||
* [[tutorial/preference_tutorial|Preference Tutorial]]
|
|
||||||
* [[tutorial/effects_tutorial|Effects Tutorial]]
|
|
||||||
* [[tutorial/multimedia_tutorial|Multimedia Tutorial]]
|
|
||||||
* [[tutorial/javascript_tutorial|JavaScript Tutorial]]
|
|
||||||
|
|
||||||
=== Programming Guide ===
|
That's it for the basics - hopefully you are now up and running with
|
||||||
|
the EFL (and perhaps Enlightenment too!) and looking to learn more.
|
||||||
|
Here is a collection of guides and tutorials to help you get deeper into
|
||||||
|
working with our libraries and building great apps.
|
||||||
|
|
||||||
|
Be sure to [[contact]] to show what youve built!
|
||||||
|
|
||||||
|
<columns 100% 33% - 33% ->
|
||||||
|
|
||||||
|
==== Programming Guide ====
|
||||||
|
|
||||||
* [[program_guide/basic_application_structure_pg|Basic Application structure]]
|
* [[program_guide/basic_application_structure_pg|Basic Application structure]]
|
||||||
* [[program_guide/eina_pg|Eina]]
|
* [[program_guide/eina_pg|Eina]]
|
||||||
|
@ -86,23 +117,38 @@ A core part of Enlightenment and EFL is the design/theme abstraction layer. This
|
||||||
* [[program_guide/multilingual_pg|Multilingual]]
|
* [[program_guide/multilingual_pg|Multilingual]]
|
||||||
* [[program_guide/evasgl_pg|Evas GL]]
|
* [[program_guide/evasgl_pg|Evas GL]]
|
||||||
|
|
||||||
|
<newcolumn>
|
||||||
|
|
||||||
|
==== Tutorials ====
|
||||||
|
|
||||||
|
* [[tutorial/basic_tutorial|Basic Tutorial]]
|
||||||
|
* [[tutorial/genlist_tutorial|Genlist Tutorial]]
|
||||||
|
* [[tutorial/panes_tutorial|Panes Tutorial]]
|
||||||
|
* [[tutorial/form_tutorial|Form Tutorial]]
|
||||||
|
* [[tutorial/menu_tutorial|Menu Tutorial]]
|
||||||
|
* [[tutorial/naviframe_tutorial|Naviframe Tutorial]]
|
||||||
|
* [[tutorial/popup_tutorial|Popup Tutorial]]
|
||||||
|
* [[tutorial/gl_2d_tutorial|GL 2D Tutorial]]
|
||||||
|
* [[tutorial/preference_tutorial|Preference Tutorial]]
|
||||||
|
* [[tutorial/effects_tutorial|Effects Tutorial]]
|
||||||
|
* [[tutorial/multimedia_tutorial|Multimedia Tutorial]]
|
||||||
|
* [[tutorial/javascript_tutorial|JavaScript Tutorial]]
|
||||||
|
|
||||||
=== Samples ===
|
=== Samples ===
|
||||||
|
|
||||||
* [[samples/elm_min_size_control|Controlling Minimum Size of Widgets]]
|
* [[samples/elm_min_size_control|Controlling Minimum Size of Widgets]]
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
==== API Documentation ====
|
<newcolumn>
|
||||||
|
|
||||||
Our documentation is a bit scarce at the moment, but that is something
|
==== Themes / Edje / EDC ====
|
||||||
we intend to solve. We will collect all documentation here and work on
|
|
||||||
improving our API references a lot.
|
|
||||||
|
|
||||||
=== Last Release ===
|
A core part of Enlightenment and EFL is the design/theme abstraction layer. This is handled by the Edje library and a series of tools that can compile/package up theme files and compress them, decompile them, and even provide some GUI editors too.
|
||||||
|
|
||||||
* [[http://docs.enlightenment.org/efl/current|EFL]]
|
* [[about-eflete|Eflete]] - GUI Theme design tool
|
||||||
* [[http://docs.enlightenment.org/python-efl/current|Python Bindings]]
|
* [[about-enventor|Enventor]] GUI Edje file design tool
|
||||||
|
* [[themes/start|Getting started]] with Edje and themes at the EDC file level
|
||||||
|
* [[themes/knob_example|Edje theme example]] A knob theme for the Elementary slider widget
|
||||||
|
|
||||||
=== Our upcoming EO based API documentation ===
|
</columns>
|
||||||
|
|
||||||
* [[docs/efl/auto/reference|EFL EO API documentation]]
|
|
||||||
|
|
Loading…
Reference in New Issue