From d5b05d640bbf3a18595595952cd2b59eb5e58e47 Mon Sep 17 00:00:00 2001 From: Jonathan Kelley Date: Fri, 7 Jan 2022 21:56:44 -0500 Subject: [PATCH] docs: add more doc --- docs/guide/src/SUMMARY.md | 20 +++++++++----------- docs/guide/src/async/fetching.md | 1 + docs/guide/src/elements/propsmacro.md | 1 + docs/guide/src/setup.md | 17 +++++++++++++++++ docs/guide/src/tutorial/index.md | 2 +- docs/guide/src/tutorial/new_app.md | 15 ++++++++++----- 6 files changed, 39 insertions(+), 17 deletions(-) create mode 100644 docs/guide/src/async/fetching.md create mode 100644 docs/guide/src/elements/propsmacro.md diff --git a/docs/guide/src/SUMMARY.md b/docs/guide/src/SUMMARY.md index 50c63f6d8..2e77d4ab8 100644 --- a/docs/guide/src/SUMMARY.md +++ b/docs/guide/src/SUMMARY.md @@ -6,33 +6,31 @@ - [Describing the UI](elements/index.md) - [Intro to Elements](elements/vnodes.md) - [Intro to Components](elements/components.md) + - [The Props Macro](elements/propsmacro.md) - [Reusing, Importing, and Exporting Components](elements/exporting_components.md) - [Passing children and attributes](elements/component_children.md) - [Conditional Rendering](elements/conditional_rendering.md) - [Lists](elements/lists.md) - [Adding Interactivity](interactivity/index.md) - [Hooks and Internal State](interactivity/hooks.md) - - - - - - - + - [Bundling](tutorial/publishing.md) - [Next Steps and Advanced Topics](final.md) diff --git a/docs/guide/src/async/fetching.md b/docs/guide/src/async/fetching.md new file mode 100644 index 000000000..99e726c7a --- /dev/null +++ b/docs/guide/src/async/fetching.md @@ -0,0 +1 @@ +# Fetching diff --git a/docs/guide/src/elements/propsmacro.md b/docs/guide/src/elements/propsmacro.md new file mode 100644 index 000000000..7426a73bf --- /dev/null +++ b/docs/guide/src/elements/propsmacro.md @@ -0,0 +1 @@ +# The Props Macro diff --git a/docs/guide/src/setup.md b/docs/guide/src/setup.md index 142ba5413..9b49f6cb5 100644 --- a/docs/guide/src/setup.md +++ b/docs/guide/src/setup.md @@ -30,6 +30,23 @@ Once installed, make sure to install wasm32-unknown-unknown as a target if you' rustup target add wasm32-unknown-unknown ``` +### Platform-Specific Dependencies + +If you are running a modern, mainstream operating system, you should need no additional setup to build WebView-based Desktop apps. However, if you are running an older version of Windows or a flavor of linux with no default web rendering engine, you might need to install some additional dependencies. + +For windows users: download the [bootstrapper for Webview2 from Microsoft](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) + +For linux users, we need the development libraries for libgtk. + +```` +sudo apt install libwebkit2gtk-4.0-dev libgtk-3-dev libappindicator3-dev +``` + +When distributing onto older Windows platforms or less-mainstream + + + + ### Dioxus-CLI for dev server, bundling, etc. We also recommend installing the Dioxus CLI. The Dioxus CLI automates building and packaging for various targets and integrates with simulators, development servers, and app deployment. To install the CLI, you'll need cargo (should be automatically installed with Rust): diff --git a/docs/guide/src/tutorial/index.md b/docs/guide/src/tutorial/index.md index 27da59807..875b74bcd 100644 --- a/docs/guide/src/tutorial/index.md +++ b/docs/guide/src/tutorial/index.md @@ -17,7 +17,7 @@ The app is running on the web [here]() but is also available: - a mobile app - and as an API endpoint here -![Weather App Image](static/weather_app.png) +![Weather App Image](/static/weather_app.png) Let's get started! Head on to the next chapter where we create our app. diff --git a/docs/guide/src/tutorial/new_app.md b/docs/guide/src/tutorial/new_app.md index 1fb928cfc..ba28372c3 100644 --- a/docs/guide/src/tutorial/new_app.md +++ b/docs/guide/src/tutorial/new_app.md @@ -1,10 +1,10 @@ # New app -To get started, let's create a new Rust project for our app. +To get started, let's create a new Rust project for our Dog Search Engine. ```shell -$ cargo new --bin weatherapp -$ cd weatherapp +$ cargo new --bin doggo +$ cd doggo ``` Make sure our project builds by default @@ -12,9 +12,9 @@ Make sure our project builds by default ```shell $ cargo run - Compiling weatherapp v0.1.0 + Compiling doggo v0.1.0 Finished dev [unoptimized + debuginfo] target(s) in 0.41s - Running `target/debug/weatherapp` + Running `target/debug/doggo` Hello, world! ``` @@ -53,3 +53,8 @@ fn app(cx: Scope) -> Element { ## Making sure things run + + + + +