Document starting instructions

README.md

@@ -3,31 +3,75 @@ A lightweight Universal Windows proxy app based on https://github.com/eycorsican
 
 ## Features
 
+- Comes with Leaf core:
+   - Domain name resolution with built-in DNS processor
+   - `tun`/`http`/`socks`/`trojan`/`ws` chainable inbounds
+   - `direct`/`drop`/`tls`/`ws`/`h2`/`shadowsocks`/`vmess`/`trojan`/`socks` chainable outbounds
+   - `failover`/`tryall`/`random`/`retry` composed outbounds
+   - `amux` multiplexing
+   - Rule system based on IP, GeoIP and domain name
+   - External rules from GeoIP database and V2Ray [Domain List Community](https://github.com/v2fly/domain-list-community)
 - Configuration management
 - Outbound network adapter selection
 - UWP VPN Platform as TUN provider
 
+## Screenshots
+
+![Settings Page](image/screenshot-setting1.png?raw=true)
+
+## Getting Started
+
+Maple as a UWP app is distributed for sideloading only. When installed, it acts as a VPN provider which you will find in the VPN Settings. Use Maple app for configuration management, as well as adding external databases.
+
+### Install
+
+1. Grab the latest package from [Release](https://github.com/YtFlow/Maple/releases) page.
+2. Extract everything from the package.
+3. Right click the certificate (named `Maple.App_x.y.z.0_x64.cer`) and select Install Certificate.
+4. On the Certificate Import Wizard, select **Local Machine**. Administrator privileges may be required to proceed.
+5. Import the certificate to the **Trusted Root Certification Authorities** folder. *Note: failure to import the certificate or choosing a wrong certificate store will prevent you from installing the app.*
+6. Open the AppxBundle (named `Maple.App_x.y.z.0_x64.appxbundle`) and follow the instructions until Maple is successfully installed on your computer.
+
+### Set up
+
+1. Launch Maple from the Start menu.
+2. Edit configuration. Refer to https://github.com/eycorsican/leaf/blob/master/README.zh.md for further explanation.
+3. Save the configuration file.
+4. If any `EXTERNAL` or `GEOIP` directive is used, drag external database files into `Config` area. V2Ray Domain List Community database can be fetched at https://github.com/v2ray/domain-list-community/releases/latest/download/dlc.dat . For GeoIP database, see [this script](https://github.com/eycorsican/ileaf/blob/main/misc/download_data.sh#L10) for inspiration.
+5. Rename these databases accordingly (if applicable). By default, GeoIP database is `geo.mmdb` and V2Ray Domain List Community database is `site.dat`.
+6. Go to Setting page in Maple. Choose your network adapter such as `Ethernet` or `WLAN`.
+7. Launch [Windows Settings](	ms-settings:network-vpn) app.
+8. Add a VPN connection.
+   - For VPN provider, choose **Maple**.
+   - In the Connection name box, enter **Maple**.
+   - In the Server name or address box, enter https://github.com/YtFlow/Maple .
+   - Select Save.
+
+### Connect
+
+1. Launch [Windows Settings](	ms-settings:network-vpn) app.
+2. In the VPN Settings, select **Maple**, and then Connect.  
+*Note: Modifying the current configuration file while VPN is connected will take effect immediately.*
+3. Select Disconnect to disconnect.
+
 ## TODO
 
+- VPN lifecycle management on Maple UI
+- Better editing experience
 - Log collection (currently logs are sent to Visual Studio Output window for debugging only)
-- `external` entries
+- <del>`external` entries</del>
 - VPN On Demand
 - Configurable routing entries
 
-## Screenshots
-
-![Settings Page](image/screenshot-setting1.png?raw=true)
-
-
 ## Build
 
 To build Leaf and Maple, a Rust `nightly-x86_64-pc-windows-msvc` toolchain, Windows 10 SDK 10.0.19041 and Visual Studio 2019 with C++ Development Workflow are required. [C++/WinRT Visual Studio extension](https://marketplace.visualstudio.com/items?itemName=CppWinRTTeam.cppwinrt101804264) must be installed to generate Windows Metadata.
 
 1. **Recursively** clone this repository.
-2. Open an *x64 Native Tools Command Prompt for VS 2019*.
-3. Change working directory to `leaf/leaf-mobile`.
+2. Open a PowerShell Prompt.
+3. Change working directory to `leaf/leaf-ffi`.
 4. `cargo build -Z build-std=std,panic_abort --target x86_64-uwp-windows-msvc`.  
-   For Release builds, use `--release`.  
+   For Release builds, use `cargo build -Z build-std=std,panic_abort --target x86_64-uwp-windows-msvc --release`.  
    See also https://github.com/eycorsican/leaf#build .
 5. Open `Maple.sln` in Visual Studio.
 6. Build Solution.