Start documenting Servonk + suggested structure

docs/architecture-and-execution.md

@@ -0,0 +1 @@
+This will describe the architecture of Servonk and how it executes.

docs/build-aries-l.md

@@ -0,0 +1 @@
+This will describe how to build for the Sony Xperia Z3 Compact based on Android L/5.0. This device is known as the aries-l. The instructions will be confirmed using Docker.

docs/build-linux-glutin.md

@@ -0,0 +1 @@
+This will describe how to build for Linux using Glutin. Instructions will be confirmed using Docker.

docs/build-nexus-5-l.md

@@ -0,0 +1 @@
+This will describe how to build for the Nexus 5. The instructions will be confirmed using Docker.

docs/build-process.md

@@ -0,0 +1 @@
+This will decribe the flow of the build process for Servonk including the dependent repositories. Note that it will not attempty to fully describe the build process for the platforms (Gonk, GNU/Linux, etc) nor Servo as these should be described elsewhere.

docs/get-servonk.md

@@ -0,0 +1 @@
+This will describe how to get a running version of Servonk.

docs/organisation.md

@@ -0,0 +1,40 @@
+This will describe the files in the Servonk repo AND the other dependent repos.
+
+# [Servonk repo](https://github.com/fabricedesre/servonk)
+## Root
+### [rust-toolchain](https://github.com/fabricedesre/servonk/blob/master/rust-toolchain)
+Contains the current version of the Rust toolchain which is used by Servo. This is updated by manually running update-servo.sh script.
+
+### [bootstrap.sh](https://github.com/fabricedesre/servonk/blob/master/bootstrap.sh)
+This checks the current version of the [rust-toolchain](https://github.com/fabricedesre/servonk/blob/master/rust-toolchain), installs the rust toolchain for your current platform and the target armv7-linux-androideabi uaing the current vrsion and sets the override so that within the Servonk directory it will use this installed version of the toolchain for work on Servonk. This will only work if you have already installed [rustup](https://github.com/rust-lang-nursery/rustup.rs), which is part of the dependencies for Servo (and therefore Servonk) as described [here](https://github.com/servo/servo/blob/master/README.md#setting-up-your-environment).
+
+[Bindgen](https://github.com/rust-lang-nursery/rust-bindgen) is needed to generate Rust FFI bindings to the [mtdev C library](https://github.com/fabricedesre/servonk/tree/master/platform/gonk/mtdev/mtdev-1.1.5). "command -v bindgen >/dev/null 2>&1 || { etc..." checks if bindgen exists and if not it installs it with "cargo install -f bindgen".
+
+### [servonk](https://github.com/fabricedesre/servonk/blob/master/servonk)
+This is the main script for interfacing with Servonk. It's parameters are the functions you wish to perform, on which platform and with which options. The functions call other scripts in the [/platform](https://github.com/fabricedesre/servonk/tree/master/platform) for the specified platform, e.g. [/platform/gonk/support/scripts](https://github.com/fabricedesre/servonk/tree/master/platform/gonk/support/scripts) for Gonk.
+
+Usage: ./servonk {build|clean|flash|package|run} {gonk|glutin} <opts>
+
+Functions:
+* _build_ Servonk for specified platform.
+* _clean_ the Servonk build files for the specified platform.
+* _flash_ Servonk to the specified platform (not for Glutin)
+* _frontend_ which only flashes the frontend of Servonk, it does not update the rest (not for Glutin)
+* _package_ the built Servonk runtimes for distribution, e.g. as a [release](https://github.com/fabricedesre/servonk/releases)
+* _run_ Servonk for the specified platform
+
+Supported platforms:
+* _gonk_
+* _glutin_
+
+Options:
+* These depend on the function; to be completed.
+
+### [update-servo.sh](https://github.com/fabricedesre/servonk/blob/master/update-servo.sh)
+This script updates the Servonk repo with key resources from a Servo repository. The location of the Servo repository is given as an argument to the script. The script copies:
+* The /resources directory of the Servo repository into the [/platform/shared](https://github.com/fabricedesre/servonk/tree/master/platform/shared/resources) directory of the Servonk repository,
+* The cargo.lock file into the [/platform/gonk](https://github.com/fabricedesre/servonk/tree/master/platform/gonk) and [/platform/glutin](https://github.com/fabricedesre/servonk/tree/master/platform/glutin) directories of the Servonk repository
+* rust-toolchain into the Servonk respository
+* For Gonk only, update the [cargo.lock](https://github.com/fabricedesre/servonk/blob/master/platform/gonk/Cargo.lock) with the package versions for Fabrice's forks of [mozjs_sys](https://github.com/fabricedesre/mozjs.git), [rust-webvr](https://github.com/fabricedesre/rust-webvr.git) and [rust-webvr-api](https://github.com/fabricedesre/rust-webvr.git).
+
+The script also runs [bootstrap.sh](https://github.com/fabricedesre/servonk/blob/master/bootstrap.sh) to update the Rust toolchain and Bindgen.

docs/run-releases.md

@@ -0,0 +1 @@
+This will describe how to run the ready-built releases of Servonk.

docs/target-devices-and-platforms.md

@@ -11,6 +11,8 @@ Using Glutin:
 To do: add links to the build instructions for each of the working devices.
 
 # Work in progress
+* AOSP 8.1 in Android Emulator - vmx from IRC #b2g, built but not running
+* AOSP 6.0 - confirmed working by Fabrice in Telegram group
 * macOS using Glutin - @novski in Telegram, confirmed built, instructions to be written and need confirmation it's running.
 * Flame - @penserbjorne has stated a desire to get this working in the repo issues.
 

docs/troubleshooting.md

@@ -0,0 +1 @@
+This will describe troubleshooting tips for building and running Servonk based on the experience of other contributors.

todo.md

@@ -6,11 +6,15 @@ Servonk feature list
 
 ## Lockscreen
 - [x] lock after 1min of inactivity or when pressing the power button.
+- [ ] main.js: replace idle event listener with a proper signal from the Servo side.
+- [ ] main.js: turn off and turn off the screen properly
 
 ## Virtual Keyboard
 (see attachResizeListener)
 - [ ] script injection to listen to focus/blur events for now.
 - [ ] open keyboard... how to send back events?
+- [ ] layout_dictionary_downloader.js: harden the verification
+- [ ] candidate_panel_view.js: (latin too) Don't create a business logic object in these views
 
 ## Window manager
 - [x] frames are layout side by side.
@@ -20,12 +24,20 @@ Servonk feature list
 - [x] the window title is displayed in the status bar.
 - [x] the favicon is displayed in the status bar.
 - [ ] pressing the status bar opens details/action for the site (eg. bookmarking).
+- [ ] browser_window.rs: Change the scale based on the phone display's DPI.
 
 ## Homescreen
 - [ ] basic grid of bookmarked sites.
 - [ ] reorganize icons by dragging them around.
 - [ ] grouping by folders / sections?
 - [ ] automatic grouping by origin?
+- [ ] statusbar.js: Use a default favicon
+
+## Search
+- [ ] search_panel.js:
+  - [ ] Implement abortable fetch() in Servo instead for the search suggestion fetcher
+  - [ ] Don't hardcode Google as the default search engine (in utils.js too)
+  - [ ] Update top sites fetcher by dispatching to worker
 
 ## Menu (short press on the menu icon)
 - [ ] opens a panel with the search field at the bottom and quick settings on top.
@@ -50,6 +62,7 @@ Servonk feature list
   - [ ] wifi (open and wpa/wpa2).
   - [ ] vibration?
   - [ ] lights?
+- [ ] lib.rs: Why is disable_signals() preventing shutdown?
 
 # Notifications
 - [ ] from the desktop notifications api.
@@ -84,7 +97,15 @@ Servonk feature list
 - [x] Desktop packages (Linux).
 - [ ] Desktop packages (Windows & Mac).
 
-
 ## Tests
 - [ ] Embedding tests.
 - [ ] Frontend tests.
+
+## Dependencies
+- [ ] bootstrap.sh: Check the current Rust version and only call rustup if needed
+
+## Building
+- [ ] mtdev/build.rs: Unwrap the directory less when generating mod.rs
+
+
+