summaryrefslogtreecommitdiff
path: root/pages/docs.txt
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-07-15 23:10:38 +0100
committerAndy Williams <andy@andywilliams.me>2017-07-15 23:10:38 +0100
commit4801c2a624ffdcc68a28f77017d65323996d3e8f (patch)
treea839163b6ef30cf04bfc9bd1ba52b7e1c5c68cc0 /pages/docs.txt
parent5f2b58d93dc369df29ea4c1b9c79a4674dc8c6cd (diff)
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
Diffstat (limited to 'pages/docs.txt')
-rwxr-xr-x[-rw-r--r--]pages/docs.txt120
1 files changed, 83 insertions, 37 deletions
diff --git a/pages/docs.txt b/pages/docs.txt
index 470c18a61..8930a884e 100644..100755
--- a/pages/docs.txt
+++ b/pages/docs.txt
@@ -2,7 +2,17 @@
2 2
3{{page>start-shortcuts}} 3{{page>start-shortcuts}}
4 4
5==== Getting into Development ==== 5==== Enlightenment and EFL Developer Documentation ====
6
7Enlightenment has developed from a window manager into a set of libraries
8that support a large number of exciting applications.
9Aimed primarily at slick graphical presentation and optimal runtime we
10created the Enlightenment Foundation Libraries and have created the following
11documentation to help everyone get involved - thanks for stopping by.
12
13<columns 100% 33% - 33% ->
14
15====Getting Started====
6 16
7If you are going to use EFL, we encourage you to actually work with 17If you are going to use EFL, we encourage you to actually work with
8EFL from [[http://git.enlightenment.org|git]] mostly because it allows 18EFL 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.
26Go check the current available version of EFL on each distro/platform: 36Go check the current available version of EFL on each distro/platform:
27[[https://phab.enlightenment.org/w/packaging_status/|Table of current version of EFL]] 37[[https://phab.enlightenment.org/w/packaging_status/|Table of current version of EFL]]
28 38
29=== Feedback === 39=== Working with Code ===
30 40
31 * [[debugging/report_bugs|Report bugs on Phabricator]] 41 * [[docs/c/start|A basic primer on C]]
32 * [[contact/arcanist|Submit patch on Phabricator]]
33 42
34=== Working with EFL and Code ===
35 43
36 * [[docs/c/start|A basic primer on C]] 44<newcolumn>
45
46====EFL Documentation====
47
48The EFL is currently undergoing a significant redesign to give a better
49developer experience when building apps using our platform.
50For now we recommend using the stable API and it's Bindings.
51
52=== Working with EFL ===
53
37 * [[docs/efl/start|Get started with EFL]] 54 * [[docs/efl/start|Get started with EFL]]
38 * [[docs-efl-debug|Debugging (generic) - EFL and Enlightenment]]
39 * [[docs/efl/advanced/start|Advanced EFL Topics]] 55 * [[docs/efl/advanced/start|Advanced EFL Topics]]
40 56
41=== Themes / Edje / EDC === 57=== Stable API ===
42 58
43A 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. 59 * [[http://docs.enlightenment.org/efl/current|C (our main language)]]
60 * [[http://docs.enlightenment.org/python-efl/current|Python Bindings]]
44 61
45 * [[about-eflete|Eflete]] - GUI Theme design tool 62=== Beta API using EO ===
46 * [[about-enventor|Enventor]] GUI Edje file design tool 63
47 * [[themes/start|Getting started]] with Edje and themes at the EDC file level 64 * [[docs/efl/auto/reference|EFL EO API documentation (C)]]
48 * [[themes/knob_example|Edje theme example]] A knob theme for the Elementary slider widget 65
66
67<newcolumn>
68
69====Contributing====
70
71We are really excited that you would like to get involved in EFL and
72Enlightenment development! If you followed the instructions in
73"Getting Started" then you are most of the way to being part of the team.
74To start with it's easiest to see which area you would like to work on and
75get involved in bug reporting or fixing. From there you can get to know the
76team, how we work, and earn a place on the team as a core developer :)
77
78=== Feedback ===
79
80 * [[debugging/report_bugs|Report bugs on Phabricator]]
81 * [[contact/arcanist|Submit patch on Phabricator]]
49 82
50=== Debugging === 83=== Debugging ===
51 84
85 * [[docs-efl-debug|Debugging (generic) - EFL and Enlightenment]]
52 * [[debugging/enlightenment_debugging|Enlightenment specific debugging]] 86 * [[debugging/enlightenment_debugging|Enlightenment specific debugging]]
53 * [[debugging/apps_efl_debugging|EFL application debugging]] 87 * [[debugging/apps_efl_debugging|EFL application debugging]]
54 * [[debugging/remote_debugging|Remote Debugging]] 88 * [[debugging/remote_debugging|Remote Debugging]]
55 89
56=== Tutorials ===
57 90
58 * [[tutorial/basic_tutorial|Basic Tutorial]] 91</columns>
59 * [[tutorial/genlist_tutorial|Genlist Tutorial]]
60 * [[tutorial/panes_tutorial|Panes Tutorial]]
61 * [[tutorial/form_tutorial|Form Tutorial]]
62 * [[tutorial/menu_tutorial|Menu Tutorial]]
63 * [[tutorial/naviframe_tutorial|Naviframe Tutorial]]
64 * [[tutorial/popup_tutorial|Popup Tutorial]]
65 * [[tutorial/gl_2d_tutorial|GL 2D Tutorial]]
66 * [[tutorial/preference_tutorial|Preference Tutorial]]
67 * [[tutorial/effects_tutorial|Effects Tutorial]]
68 * [[tutorial/multimedia_tutorial|Multimedia Tutorial]]
69 * [[tutorial/javascript_tutorial|JavaScript Tutorial]]
70 92
71=== Programming Guide === 93That's it for the basics - hopefully you are now up and running with
94the EFL (and perhaps Enlightenment too!) and looking to learn more.
95Here is a collection of guides and tutorials to help you get deeper into
96working with our libraries and building great apps.
97
98Be sure to [[contact]] to show what youve built!
99
100<columns 100% 33% - 33% ->
101
102==== Programming Guide ====
72 103
73 * [[program_guide/basic_application_structure_pg|Basic Application structure]] 104 * [[program_guide/basic_application_structure_pg|Basic Application structure]]
74 * [[program_guide/eina_pg|Eina]] 105 * [[program_guide/eina_pg|Eina]]
@@ -86,23 +117,38 @@ A core part of Enlightenment and EFL is the design/theme abstraction layer. This
86 * [[program_guide/multilingual_pg|Multilingual]] 117 * [[program_guide/multilingual_pg|Multilingual]]
87 * [[program_guide/evasgl_pg|Evas GL]] 118 * [[program_guide/evasgl_pg|Evas GL]]
88 119
120<newcolumn>
121
122==== Tutorials ====
123
124 * [[tutorial/basic_tutorial|Basic Tutorial]]
125 * [[tutorial/genlist_tutorial|Genlist Tutorial]]
126 * [[tutorial/panes_tutorial|Panes Tutorial]]
127 * [[tutorial/form_tutorial|Form Tutorial]]
128 * [[tutorial/menu_tutorial|Menu Tutorial]]
129 * [[tutorial/naviframe_tutorial|Naviframe Tutorial]]
130 * [[tutorial/popup_tutorial|Popup Tutorial]]
131 * [[tutorial/gl_2d_tutorial|GL 2D Tutorial]]
132 * [[tutorial/preference_tutorial|Preference Tutorial]]
133 * [[tutorial/effects_tutorial|Effects Tutorial]]
134 * [[tutorial/multimedia_tutorial|Multimedia Tutorial]]
135 * [[tutorial/javascript_tutorial|JavaScript Tutorial]]
136
89=== Samples === 137=== Samples ===
90 138
91 * [[samples/elm_min_size_control|Controlling Minimum Size of Widgets]] 139 * [[samples/elm_min_size_control|Controlling Minimum Size of Widgets]]
92 140
93----
94 141
95==== API Documentation ==== 142<newcolumn>
96 143
97Our documentation is a bit scarce at the moment, but that is something 144==== Themes / Edje / EDC ====
98we intend to solve. We will collect all documentation here and work on
99improving our API references a lot.
100 145
101=== Last Release === 146A 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.
102 147
103 * [[http://docs.enlightenment.org/efl/current|EFL]] 148 * [[about-eflete|Eflete]] - GUI Theme design tool
104 * [[http://docs.enlightenment.org/python-efl/current|Python Bindings]] 149 * [[about-enventor|Enventor]] GUI Edje file design tool
150 * [[themes/start|Getting started]] with Edje and themes at the EDC file level
151 * [[themes/knob_example|Edje theme example]] A knob theme for the Elementary slider widget
105 152
106=== Our upcoming EO based API documentation === 153</columns>
107 154
108 * [[docs/efl/auto/reference|EFL EO API documentation]]