update README for 0.5 release

decred · Aug 5, 2022 · 287b9f8 · 287b9f8
1 parent cfdfcc4
commit 287b9f8
Show file tree

Hide file tree

Showing 15 changed files with 206 additions and 147 deletions.
diff --git a/.gitignore b/.gitignore
@@ -24,7 +24,7 @@ client/cmd/dexcctl/dexcctl
 client/cmd/assetseed/assetseed
 client/cmd/simnet-trade-tests/simnet-trade-tests
 docs/examples/rpcclient/rpcclient
-wiki
+/wiki
 dex/testing/loadbot/loadbot
 bin/
 client/webserver/site/template-builder/template-builder

diff --git a/README.md b/README.md
diff --git a/docs/images/add-dex-reg.png b/docs/images/add-dex-reg.png
diff --git a/docs/images/choose-fee.png b/docs/images/choose-fee.png
diff --git a/docs/images/client-pw.png b/docs/images/client-pw.png
diff --git a/docs/images/confirm-reg.png b/docs/images/confirm-reg.png
diff --git a/docs/images/create-btc.png b/docs/images/create-btc.png
diff --git a/docs/images/decred-reg.png b/docs/images/decred-reg.png
diff --git a/docs/images/electrum-rpc-config.png b/docs/images/electrum-rpc-config.png
diff --git a/docs/images/register-button.png b/docs/images/register-button.png
diff --git a/docs/images/sync-fund-btc.png b/docs/images/sync-fund-btc.png
diff --git a/docs/images/view-seed.png b/docs/images/view-seed.png
diff --git a/docs/images/wait-for-confs.png b/docs/images/wait-for-confs.png
diff --git a/docs/wiki/Client-applications.md b/docs/wiki/Client-applications.md
@@ -0,0 +1,30 @@
+## Client Applications and the Core Package
+
+### Applications
+
+There are two client applications.
+
+#### dexc
+
+The **browser-based GUI** (a.k.a. "the app") offers a familiar exchange
+experience in your browser. The app is really just a one-client web server that
+you run and connect to on the same machine. The market view allows you to see
+the market's order book in sorted lists or as a depth chart. You can place your
+order and monitor its status in the same market view. The GUI application is
+managed by the **dexc** utility in *client/cmd/dexc*.
+
+Most users will only need to use this application.
+
+See the README for instructions on obtaining and starting **dexc**.
+
+#### dexcctl
+
+The **dexcctl** utility enables trading via CLI. Commands are parsed and
+issued to **Core** for execution. **dexcctl** also requires **dexc**.
+
+### Core client Go language package
+
+For developers, the `decred.org/dcrdex/client/core` Go language package provides
+the `Core` client type, which offers an intuitive programmer interface, with
+methods for creating wallets, registering DEX accounts, viewing markets, and
+performing trades.
diff --git a/docs/wiki/Localization-and-Translation.md b/docs/wiki/Localization-and-Translation.md
@@ -16,6 +16,9 @@ The new HTML strings map must then be listed in https://github.com/decred/dcrdex
 
 Once the new file is created in **client/webserver/locales** and the new map registered in **client/webserver/locales/locales.go**, it is then necessary to run `go generate` in the **client/webserver/site** folder.  This creates the localized HTML template files in the **localized_html** folder.
 
+If you modify any of the HTML templates in *client/webserver/site/src/html*, it
+is also necessary to regenerate the localize templates with `go generate`.
+
 ## Step 2 - Notifications
 
 The notification strings involved editing [client/core/locale_ntfn.go](https://github.com/decred/dcrdex/blob/master/client/core/locale_ntfn.go) with a new `var zhCN map[Topic]*translation`. These translations correspond to the English strings in the `enUS` map in the same file.