Merge pull request #64 from hecrj/improvement/update-readmes

Update repository documentation

18 files changed, 236 insertions, 12 deletions

diff --git a/docs/crates_graph.dot b/docs/crates_graph.dot
deleted file mode 100644
index 85e375d0..00000000
--- a/docs/crates_graph.dot
+++ /dev/null
@@ -1,12 +0,0 @@
-digraph G {
-  "iced_core" -> "iced_native"
-  "iced_core" -> "iced_web"
-  "iced_native" -> "iced_wgpu"
-  "iced_native" -> "iced_winit"
-  "iced_web" -> "iced"
-  "iced_wgpu" -> "iced"
-  "iced_winit" -> "iced"
-
-  node[shape=box];
-  "iced" -> "cross-platform application"
-}
diff --git a/docs/crates_graph.png b/docs/crates_graph.png
deleted file mode 100644
index d598c1dd..00000000
--- a/docs/crates_graph.png
+++ /dev/null
diff --git a/docs/graphs/core.dot b/docs/graphs/core.dot
new file mode 100644
index 00000000..93724927
--- /dev/null
+++ b/docs/graphs/core.dot
@@ -0,0 +1,13 @@
+digraph G {
+  fontname = "Roboto";
+  newrank=true;
+  node[fontname = "Roboto", style="filled", fontcolor="#333333", fillcolor=white, color="#333333"];
+  edge[color="#333333"];
+
+  { rank = same; iced_native iced_web }
+
+  iced_core -> iced_native [style=dashed];
+  iced_core -> iced_web [style=dashed];
+
+  iced_core [style=dashed];
+}
diff --git a/docs/graphs/core.png b/docs/graphs/core.png
new file mode 100644
index 00000000..0b14ab6c
--- /dev/null
+++ b/docs/graphs/core.png
diff --git a/docs/graphs/ecosystem.dot b/docs/graphs/ecosystem.dot
new file mode 100644
index 00000000..609cf726
--- /dev/null
+++ b/docs/graphs/ecosystem.dot
@@ -0,0 +1,56 @@
+digraph G {
+  fontname = "Roboto";
+  newrank=true;
+  node[fontname = "Roboto", style="filled", fontcolor="#333333", fillcolor=white, color="#333333"];
+  edge[color="#333333"];
+
+  subgraph cluster_1 {
+    label = "renderers  ";
+    labelloc = "b";
+    labeljust = "r";
+    fontcolor = "#0366d6";
+    color="#f6f8fa";
+    bgcolor="#f6f8fa";
+    style=rounded;
+
+    etc_1 [label="...", style=solid, shape=none];
+    iced_wgpu;
+  }
+
+  subgraph cluster_2 {
+    label = "shells  ";
+    labelloc = "b";
+    labeljust = "r";
+    fontcolor = "#0366d6";
+    color="#f6f8fa";
+    bgcolor="#f6f8fa";
+    style=rounded;
+
+    etc_2 [label="...", style=solid, shape=none];
+    iced_winit;
+  }
+
+  subgraph cluster_3 {
+    style=invis;
+    margin=20;
+    iced;
+  }
+
+  { rank = same; iced_native iced_web }
+  { rank = same; iced_wgpu iced_winit etc_1 etc_2 }
+
+  iced_core -> iced_native [style=dashed];
+  iced_core -> iced_web [style=dashed];
+  iced_native -> iced_wgpu;
+  iced_native -> iced_winit;
+
+  iced_winit -> iced;
+  iced_wgpu -> iced;
+  iced_web -> iced;
+
+  iced -> "cross-platform application";
+
+  iced_core [style=dashed];
+
+  "cross-platform application" [shape=box, width=2.8, height=0.6];
+}
diff --git a/docs/graphs/ecosystem.png b/docs/graphs/ecosystem.png
new file mode 100644
index 00000000..03fe1130
--- /dev/null
+++ b/docs/graphs/ecosystem.png
diff --git a/docs/graphs/generate.sh b/docs/graphs/generate.sh
new file mode 100755
index 00000000..45073820
--- /dev/null
+++ b/docs/graphs/generate.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+for file in *.dot
+do
+  dot -Tpng ${file} -o ${file%.*}.png
+done
diff --git a/docs/graphs/iced.dot b/docs/graphs/iced.dot
new file mode 100644
index 00000000..24dbb972
--- /dev/null
+++ b/docs/graphs/iced.dot
@@ -0,0 +1,46 @@
+digraph G {
+  fontname = "Roboto";
+  newrank=true;
+  node[fontname = "Roboto", style="filled", fontcolor="#333333", fillcolor=white, color="#333333"];
+  edge[color="#333333"];
+
+  subgraph cluster_1 {
+    label = "renderers  ";
+    labelloc = "b";
+    labeljust = "r";
+    fontcolor = "#0366d6";
+    color="#f6f8fa";
+    bgcolor="#f6f8fa";
+    style=rounded;
+
+    etc_1 [label="...", style=solid, shape=none];
+    iced_wgpu;
+  }
+
+  subgraph cluster_2 {
+    label = "shells  ";
+    labelloc = "b";
+    labeljust = "r";
+    fontcolor = "#0366d6";
+    color="#f6f8fa";
+    bgcolor="#f6f8fa";
+    style=rounded;
+
+    etc_2 [label="...", style=solid, shape=none];
+    iced_winit;
+  }
+
+  subgraph cluster_3 {
+    style=invis;
+    margin=20;
+    iced;
+  }
+
+  { rank = same; iced_wgpu iced_winit etc_1 etc_2 }
+
+  iced_winit -> iced;
+  iced_wgpu -> iced;
+  iced_web -> iced;
+
+  iced;
+}
diff --git a/docs/graphs/iced.png b/docs/graphs/iced.png
new file mode 100644
index 00000000..5d4a35bc
--- /dev/null
+++ b/docs/graphs/iced.png
diff --git a/docs/graphs/native.dot b/docs/graphs/native.dot
new file mode 100644
index 00000000..b57736b5
--- /dev/null
+++ b/docs/graphs/native.dot
@@ -0,0 +1,41 @@
+digraph G {
+  fontname = "Roboto";
+  newrank=true;
+  node[fontname = "Roboto", style="filled", fontcolor="#333333", fillcolor=white, color="#333333"];
+  edge[color="#333333"];
+
+  subgraph cluster_1 {
+    label = "renderers  ";
+    labelloc = "b";
+    labeljust = "r";
+    fontcolor = "#0366d6";
+    color="#f6f8fa";
+    bgcolor="#f6f8fa";
+    style=rounded;
+
+    etc_1 [label="...", style=solid, shape=none];
+    iced_wgpu;
+  }
+
+  subgraph cluster_2 {
+    label = "shells  ";
+    labelloc = "b";
+    labeljust = "r";
+    fontcolor = "#0366d6";
+    color="#f6f8fa";
+    bgcolor="#f6f8fa";
+    style=rounded;
+
+    etc_2 [label="...", style=solid, shape=none];
+    iced_winit;
+  }
+
+
+  { rank = same; iced_wgpu iced_winit etc_1 etc_2 }
+
+  iced_core -> iced_native [style=dashed];
+  iced_native -> iced_wgpu;
+  iced_native -> iced_winit;
+
+  iced_core [style=dashed];
+}
diff --git a/docs/graphs/native.png b/docs/graphs/native.png
new file mode 100644
index 00000000..892e4fee
--- /dev/null
+++ b/docs/graphs/native.png
diff --git a/docs/graphs/web.dot b/docs/graphs/web.dot
new file mode 100644
index 00000000..853ca398
--- /dev/null
+++ b/docs/graphs/web.dot
@@ -0,0 +1,12 @@
+digraph G {
+  fontname = "Roboto";
+  newrank=true;
+  node[fontname = "Roboto", style="filled", fontcolor="#333333", fillcolor=white, color="#333333"];
+  edge[color="#333333"];
+
+  iced_core -> iced_web [style=dashed];
+
+  iced_web -> iced;
+
+  iced_core [style=dashed];
+}
diff --git a/docs/graphs/web.png b/docs/graphs/web.png
new file mode 100644
index 00000000..e6a1a5f6
--- /dev/null
+++ b/docs/graphs/web.png
diff --git a/docs/graphs/wgpu.dot b/docs/graphs/wgpu.dot
new file mode 100644
index 00000000..410c2eeb
--- /dev/null
+++ b/docs/graphs/wgpu.dot
@@ -0,0 +1,31 @@
+digraph G {
+  fontname = "Roboto";
+  newrank=true;
+  node[fontname = "Roboto", style="filled", fontcolor="#333333", fillcolor=white, color="#333333"];
+  edge[color="#333333"];
+
+  subgraph cluster_1 {
+    label = "renderers  ";
+    labelloc = "b";
+    labeljust = "r";
+    fontcolor = "#0366d6";
+    color="#f6f8fa";
+    bgcolor="#f6f8fa";
+    style=rounded;
+
+    etc_1 [label="...", style=solid, shape=none];
+    iced_wgpu;
+  }
+
+  subgraph cluster_3 {
+    style=invis;
+    margin=20;
+    iced;
+  }
+
+  { rank = same; iced_wgpu etc_1  }
+
+  iced_native -> iced_wgpu;
+
+  iced_wgpu -> iced;
+}
diff --git a/docs/graphs/wgpu.png b/docs/graphs/wgpu.png
new file mode 100644
index 00000000..4831caba
--- /dev/null
+++ b/docs/graphs/wgpu.png
diff --git a/docs/graphs/winit.dot b/docs/graphs/winit.dot
new file mode 100644
index 00000000..4ea5149a
--- /dev/null
+++ b/docs/graphs/winit.dot
@@ -0,0 +1,31 @@
+digraph G {
+  fontname = "Roboto";
+  newrank=true;
+  node[fontname = "Roboto", style="filled", fontcolor="#333333", fillcolor=white, color="#333333"];
+  edge[color="#333333"];
+
+  subgraph cluster_2 {
+    label = "shells  ";
+    labelloc = "b";
+    labeljust = "r";
+    fontcolor = "#0366d6";
+    color="#f6f8fa";
+    bgcolor="#f6f8fa";
+    style=rounded;
+
+    etc_2 [label="...", style=solid, shape=none];
+    iced_winit;
+  }
+
+  subgraph cluster_3 {
+    style=invis;
+    margin=20;
+    iced;
+  }
+
+  { rank = same; iced_winit  etc_2 }
+
+  iced_native -> iced_winit;
+
+  iced_winit -> iced;
+}
diff --git a/docs/graphs/winit.png b/docs/graphs/winit.png
new file mode 100644
index 00000000..1c028b29
--- /dev/null
+++ b/docs/graphs/winit.png
diff --git a/docs/images/todos_desktop.jpg b/docs/images/todos_desktop.jpg
new file mode 100644
index 00000000..a604fd62
--- /dev/null
+++ b/docs/images/todos_desktop.jpg