-
Notifications
You must be signed in to change notification settings - Fork 104
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
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
1647cdb
update README for 0.5 release
chappjc 3bd6189
update text of setup steps, screenshots next
chappjc 3268690
review updates
chappjc 6fe04df
move a few things from README to wiki
chappjc 435eee8
go 1.18 is the min now (go.mod later)
chappjc f91133a
update screenshots in initial setup steps
chappjc 36fd373
server daemons
chappjc ffbc62f
typos
chappjc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.