Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README for 0.5 release #1747

Merged
merged 8 commits into from
Aug 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
318 changes: 172 additions & 146 deletions README.md

Large diffs are not rendered by default.

Binary file modified docs/images/add-dex-reg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/choose-fee.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/client-pw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/confirm-reg.png
Binary file not shown.
Binary file modified docs/images/create-btc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/decred-reg.png
Binary file not shown.
Binary file added docs/images/electrum-rpc-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/register-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/sync-fund-btc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/view-seed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/wait-for-confs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions docs/wiki/Client-applications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Client Applications and the Core Package
Copy link
Member Author

@chappjc chappjc Aug 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, clearly wiki needs work. I'm not sure where this section I extracted from README belongs on the wiki since it's a mix of user application overview and an intro to the core package. I'm just taking it out of readme and putting it somewhere in wiki for more extensive subsequent revision.


### 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.
3 changes: 3 additions & 0 deletions docs/wiki/Localization-and-Translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down