From 4fff739cb43ec6ddb2960439c89b1f14a4e436c9 Mon Sep 17 00:00:00 2001 From: Antoine Pouille Date: Tue, 24 Sep 2024 18:08:28 +0200 Subject: [PATCH] More READMEs --- gui/README.md | 7 +++++-- gui/entry_point/README.md | 1 + 2 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 gui/entry_point/README.md diff --git a/gui/README.md b/gui/README.md index b8c155e8f..eb9a47529 100644 --- a/gui/README.md +++ b/gui/README.md @@ -11,9 +11,12 @@ while the other are the different workers that can be ran as webworkers/threads Files in `state` manages state logic from different app part, similar to a `model` in a Control/Model/View architecture. -`entry_point` contains TODO +`entry_point` contains the entry point info for the html main page of the webapp and electron app config + +`lib`, `lib_no_jsoo`, `js_lib` contain libs used by the webapp. Those in `lib_no_jsoo` do not depend on js_of_ocaml. Libs in `js_lib` are written in javascript`, while the other are in ocaml. + +`resources` contains resources used to build the webapp and electron app. -`viz/main.js` contains the code for the main electron process ### Runtime The app is divided in : diff --git a/gui/entry_point/README.md b/gui/entry_point/README.md new file mode 100644 index 000000000..6b0dc41c6 --- /dev/null +++ b/gui/entry_point/README.md @@ -0,0 +1 @@ +`entry_point` contains the entry point info for the html main page of the webapp and electron app config