Skip to content

Commit

Permalink
Add instructions in the README to using the mocked DFX binary. (#13)
Browse files Browse the repository at this point in the history
Co-Authored-By: Paul Young <[email protected]>
  • Loading branch information
Hans and paulyoung authored Aug 30, 2019
1 parent 5b479ea commit 0bd79a3
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
= DFINITY SDK

== Using The Mock DFX Locally
The mock DFX binary is kept on a separate branch. To use it follow these steps:

. Make a clone of this repository. If you haven't made a clone, this command line will do so:
[source,bash]
git clone https://github.com/dfinity-lab/sdk.git
cd sdk

. Make sure your repository is up to date. If you just made a clone for the first time, you can
skip this step.
[source,bash]
git fetch origin

. Checkout the `dfx-mock` branch. If you want to experiment you can create a local branch
(optional).
[source,bash]
git checkout origin/dfx-mock

. Enter a Nix shell that contains `dfx`:
[source,bash]
cd dfx
nix-shell demo.nix

. You can now run `dfx` directly from your shell.
[source,bash]
dfx help

. Done. Good job!

image:./assets/success.gif[Success!]
[source,bash]
dfx help

Binary file added assets/success.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0bd79a3

Please sign in to comment.