update README for 0.5 release #1747

chappjc · 2022-07-31T21:23:30Z

Rewriting much of the README for 0.5

lots more assets
no requirement on full nodes
no requirement on DCR for registration

Rendered here.

I have a feeling that Go 1.19 will be released this week (meaning Go 1.17 will be EOL), so that may update too.

I'm undecided on if we should update all of the setup screenshots of the current UI or remove them. The setup flow is much more intuitive now and doesn't rely on DCR as the registration asset.

Also, I think dcrinstall is not really the recommended option any more and I intend to put up all the binaries generated with the pkg.sh script directly on the dcrdex github release page. However, I think dcrinstall can at least be modified to install dex without having to give the --dcrdex switch. decred/decred-release#227

chappjc · 2022-08-01T03:10:57Z

Sorry @JoeGruffins I forgot that you were going to do something with the quick start section. I think this trims it down to just what a propsective user needs, and almost no command line stuff. Most of the command line setup junk was from before native wallets anyway.
If you have work we can merge it with this

chappjc · 2022-08-01T03:14:38Z

README.md

+on the linked page for your operating system. Otherwise see the latest DCRDEX
+releases [on Github](https://github.com/decred/dcrdex/releases) for source code
+or pre-compiled standalone packages.


I think this last sentence will be my preferred installation method that I'd recommend for 0.5. I will just upload the archives generated by the pkg.sh script to the github release when it's published. I have a hard time seeing dcrinstall being a good install method for dcrdex anymore given none of dcrd, dcrwallet, or bitcoind are needed anymore, and there's no point in scaring users with one more CLI tool. Plus dcrinstall still makes you use the --dcrdex switch to actually get dex. decred/decred-release#227

chappjc · 2022-08-01T03:24:56Z

README.md

-of the file.
-
-`wallet=dex`
+See the [wiki](../../wiki/Testnet-Testing) for details on preparing the wallets.


I didn't change this sentence, but I don't think we should link from the README to this Testnet Testing wiki page for wallet setup. Will remove this line I think. EDIT: removed this link, but see below on what I think we should do to that wiki page regardless.

Also, the entire "Testnet Testing" wiki page is quite outdated. There are multiple wallet options, so if we want to maintain some of the content from that page, we should rename it to Full Node Setup Example.
The section starting "Get the Testnet Server TLS Certificate" can remain on a "Testnet Testing" page, but all the wallet setup stuff is not really relevant anymore.

chappjc · 2022-08-01T03:27:46Z

README.md

+2. In your browser, navigate to http://localhost:5758. Skip this step if
+   using Decrediton.
+
+[//]: # "TODO: either update or remove all of these screenshots for the current UI!"


I'm leaning toward removing the screenshots (and most of the text in this section) because they can go out of date so quickly (and presently are), and generally I'd like the README to be more terse, with this sort of setup walkthrough in the wiki.

Keeping up with screenshots can be a pain.

chappjc · 2022-08-01T03:31:22Z

README.md

+If you modify any of the HTML templates in *client/webserver/site/src/html*, it
+is necessary to regenerate the localize templates in
+*client/webserver/site/src/localized_html*:
+
+```
+go generate ./...


I just moved this down here to make the "Build from Source" section short and sweet, but I think this whole "Client Applications and the Core Package" section can also leave the README and live in the wiki instead. This is all developer stuff that goes beyond just "how do I build from source as a non-developer?"

Should this Client Applications and the Core Package section should go to the wiki?

I think all the developer stuff is better in the wiki personally. I can find a spot in the wiki to dump this section so it doesn't get lost.

README.md

JoeGruffins · 2022-08-01T09:39:42Z

README.md

+2. In your browser, navigate to http://localhost:5758. Skip this step if
+   using Decrediton.
+
+[//]: # "TODO: either update or remove all of these screenshots for the current UI!"


Keeping up with screenshots can be a pain.

README.md

JoeGruffins · 2022-08-01T09:45:05Z

README.md


 <img src="docs/images/decred-reg.png" width="250">

-5. Enter the dex address, probably **dex.decred.org**.
+5. Enter the dex address of your choice, probably **dex.decred.org**.

 <img src="docs/images/add-dex-reg.png" width="250">

 6. Check the registration fee, and enter your password one more time to authorize payment.


For internal clients, you will need to send the fee first here to register. Or do we assume decrediton so this is too much info?

All of these steps are outdated. I kinda wanted to see what you guys thought about the screenshot removal idea, and then compress and update these steps for the simplified reg/setup workflow we have in this release.

Although having screenshots in the setup guide and updating them can be a burden, It is nice for users to see a visual guide and makes it easier to follow the guide.

OK, agree. Updating the text of the steps now, and will gather screenshots after we review the text.

README.md

ukane-philemon · 2022-08-02T07:35:55Z

README.md

-[on Element](https://matrix.to/#/!mlRZqBtfWHrcmgdTWB:decred.org?via=decred.org&via=matrix.org&via=planetdecred.org)
-to appeal.
+**If you fail to complete swaps** when your orders are matched, your account
+will accumulate strikes that may be lead your account becoming automatically


nit: may be lead your ->will lead to your

buck54321 · 2022-08-04T11:39:35Z

README.md

+1. For Bitcoin, [Bitcoin Core v0.21 or v22 or v23](https://bitcoincore.org/en/download/) (bitcoind or bitcoin-qt) wallet. Descriptor wallets are not supported in v0.21. Alternatively, you can use the native light wallet.
+2. For Decred, [dcrd](https://github.com/decred/dcrd) and [dcrwallet](https://github.com/decred/dcrwallet), installed from the [v1.7.x release binaries](https://github.com/decred/decred-release/releases), or built from the `release-v1.7` branches. Alternatively, you may use Decrediton or the dcrwallet application in SPV mode, or the native light wallet.


Can we switch the order here and say something like

There are no prerequisites to use the native Bitcoin wallet. To use a Bitcoin Core full node, ...

and similarly for Decred?

I'll tweak it, but this is the ### Optional External Software section, preceded by the ### Prerequisites section (which is NOT a parent section), so I felt this section was to describe what versions of the optional software was supported, with reminders when a native option is available.

buck54321 · 2022-08-04T11:45:42Z

README.md

+   will be available for trading or may be withdrawn.
+
+4. Once the wallet is synchronized and has at least enough to pay the server's
+   defined fee, you just click the button to submit the registration request.


This might seem insane, but I try my best not to use the word "just" when writing instructions. It's usually adds nothing of value and sets a tone that can backfire when things don't go as planned.

I would remove ~~you just~~.

tbh I felt the same but didn't want to nit pic

buck54321 · 2022-08-04T11:48:50Z

README.md

+DEX does not collect any fees on the trades, but since all swap transactions
+occur on-chain and are created directly by the users, they will pay network
+transaction fees. Transaction fees vary based on how orders are matched. Fee
+estimates are shown prior to order creation, and the realized fees are displayed


prior too → during.

buck54321 · 2022-08-04T11:51:51Z

README.md

+If you modify any of the HTML templates in *client/webserver/site/src/html*, it
+is necessary to regenerate the localize templates in
+*client/webserver/site/src/localized_html*:
+
+```
+go generate ./...


Should this Client Applications and the Core Package section should go to the wiki?

buck54321 · 2022-08-04T11:56:59Z

README.md

-
-It is recommended that you password-protect your Bitcoin trading wallet.
-We'll use `read` to prevent echoing the password.
+External wallet software is not required for most assets, just the DEX client!


We only have native wallets for 2 of our 6 assets. The word most here also conflicts with the statement below

There are native/built-in light wallet options for Bitcoin and Decred,
an external light wallet option for Litecoin, and full-node support for all
other assets including: Bitcoin, Decred, Litecoin, ZCash, Dogecoin, Bitcoin
Cash.

buck54321 · 2022-08-04T12:01:11Z

README.md

+   good experience for all users. No further fees are collected on trades.) At
+   this point you should select the asset you wish to use, and then configure


~~At this point you should~~

buck54321 · 2022-08-04T12:07:06Z

README.md

+3. The DEX server will support paying the one time setup fee in one or more
+   assets. (This is a nominal amount just to discourage abuse and maintain a


Maybe The DEX server will offer a choice of assets with which to pay the one-time setup fee.

chappjc · 2022-08-04T21:33:31Z

docs/wiki/Client-applications.md

@@ -0,0 +1,30 @@
+## Client Applications and the Core Package


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.

buck54321

Oh. Can you update the line

As of writing, only dcrd, bitcoind, and litecoind are supported.

while you're here?

chappjc · 2022-08-04T22:51:14Z

Updated the Initial Setup steps with new screens.

chappjc force-pushed the README-0.5 branch from b3081a0 to 8b75429 Compare July 31, 2022 21:30

chappjc commented Aug 1, 2022

View reviewed changes

chappjc force-pushed the README-0.5 branch from 8b75429 to 7a7796f Compare August 1, 2022 04:11

JoeGruffins reviewed Aug 1, 2022

View reviewed changes

JoeGruffins mentioned this pull request Aug 1, 2022

wiki: Move client quick install guide. #1715

Merged

ukane-philemon suggested changes Aug 2, 2022

View reviewed changes

chappjc added this to the 0.5 milestone Aug 2, 2022

buck54321 requested changes Aug 4, 2022

View reviewed changes

chappjc added 4 commits August 4, 2022 16:11

update README for 0.5 release

1647cdb

update text of setup steps, screenshots next

3bd6189

review updates

3268690

move a few things from README to wiki

6fe04df

chappjc force-pushed the README-0.5 branch from a630f52 to 6fe04df Compare August 4, 2022 21:31

chappjc commented Aug 4, 2022

View reviewed changes

go 1.18 is the min now (go.mod later)

435eee8

buck54321 approved these changes Aug 4, 2022

View reviewed changes

buck54321 requested changes Aug 4, 2022

View reviewed changes

update screenshots in initial setup steps

f91133a

buck54321 mentioned this pull request Aug 4, 2022

Master Issue: Documentation #1641

Closed

24 tasks

server daemons

36fd373

typos

ffbc62f

JoeGruffins approved these changes Aug 5, 2022

View reviewed changes

chappjc merged commit 287b9f8 into decred:master Aug 5, 2022

chappjc deleted the README-0.5 branch August 5, 2022 04:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update README for 0.5 release #1747

update README for 0.5 release #1747

chappjc commented Jul 31, 2022 •

edited

Loading

chappjc commented Aug 1, 2022 •

edited

Loading

chappjc Aug 1, 2022 •

edited

Loading

chappjc Aug 1, 2022 •

edited

Loading

chappjc Aug 1, 2022 •

edited

Loading

JoeGruffins Aug 1, 2022

chappjc Aug 1, 2022 •

edited

Loading

buck54321 Aug 4, 2022

chappjc Aug 4, 2022

JoeGruffins Aug 1, 2022

JoeGruffins Aug 1, 2022

chappjc Aug 2, 2022

ukane-philemon Aug 2, 2022

chappjc Aug 2, 2022

ukane-philemon Aug 2, 2022

buck54321 Aug 4, 2022

chappjc Aug 4, 2022 •

edited

Loading

buck54321 Aug 4, 2022

JoeGruffins Aug 5, 2022

buck54321 Aug 4, 2022

buck54321 Aug 4, 2022

buck54321 Aug 4, 2022

buck54321 Aug 4, 2022

buck54321 Aug 4, 2022

chappjc Aug 4, 2022 •

edited

Loading

buck54321 left a comment •

edited

Loading

chappjc commented Aug 4, 2022

		1. For Bitcoin, [Bitcoin Core v0.21 or v22 or v23](https://bitcoincore.org/en/download/) (bitcoind or bitcoin-qt) wallet. Descriptor wallets are not supported in v0.21. Alternatively, you can use the native light wallet.
		2. For Decred, [dcrd](https://github.com/decred/dcrd) and [dcrwallet](https://github.com/decred/dcrwallet), installed from the [v1.7.x release binaries](https://github.com/decred/decred-release/releases), or built from the `release-v1.7` branches. Alternatively, you may use Decrediton or the dcrwallet application in SPV mode, or the native light wallet.

		good experience for all users. No further fees are collected on trades.) At
		this point you should select the asset you wish to use, and then configure

		3. The DEX server will support paying the one time setup fee in one or more
		assets. (This is a nominal amount just to discourage abuse and maintain a

update README for 0.5 release #1747

update README for 0.5 release #1747

Conversation

chappjc commented Jul 31, 2022 • edited Loading

chappjc commented Aug 1, 2022 • edited Loading

chappjc Aug 1, 2022 • edited Loading

Choose a reason for hiding this comment

chappjc Aug 1, 2022 • edited Loading

Choose a reason for hiding this comment

chappjc Aug 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chappjc Aug 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chappjc Aug 4, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chappjc Aug 4, 2022 • edited Loading

Choose a reason for hiding this comment

buck54321 left a comment • edited Loading

Choose a reason for hiding this comment

chappjc commented Aug 4, 2022

chappjc commented Jul 31, 2022 •

edited

Loading

chappjc commented Aug 1, 2022 •

edited

Loading

chappjc Aug 1, 2022 •

edited

Loading

chappjc Aug 1, 2022 •

edited

Loading

chappjc Aug 1, 2022 •

edited

Loading

chappjc Aug 1, 2022 •

edited

Loading

chappjc Aug 4, 2022 •

edited

Loading

chappjc Aug 4, 2022 •

edited

Loading

buck54321 left a comment •

edited

Loading