Home

Jump to bottom

Jonathan Chappelow edited this page Aug 18, 2022 · 5 revisions

The dcrdex wiki provides documentation for dcrdex users and developers.

Also have a look at the README and the spec.

Usage

To get started using DCRDEX, see the Client Installation and Configuration page.

Contribute changes to the wiki

The following instructions assume that you have already forked dcrdex.

Initialize your forked wiki on github by navigating to the wiki tab of your forked dcrdex repo and clicking the "Create the first page" button. Be sure to "Save page" as well.

In your terminal, navigate to your local dcrdex directory and add your remote wiki.

git remote add wiki https://github.com/your-username/dcrdex.wiki.git
git push wiki -d master
git subtree push --prefix docs/wiki wiki master

Now after committing changes to the files in the docs/wiki folder, you can apply them to your dcrdex wiki and view immediately. Assuming you are in the root directory:

git push wiki $(git subtree split --prefix docs/wiki):master --force

Make a pull request with your changes to dcrdex. They will make it to the main wiki eventually.