Skip to content

Commit

Permalink
Added documentation on how to use a project.json file to tell the VSC…
Browse files Browse the repository at this point in the history
…ode extension how to find the client and smart contract.
  • Loading branch information
mcoblenz committed Sep 3, 2019
1 parent 0fbef6f commit 4e31477
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
20 changes: 20 additions & 0 deletions user_guide/source/compiling.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Using the Compiler
===================
We recommend using VSCode. To set it up:

- Install VSCode (https://code.visualstudio.com).
- Copy the obs-vscode-extension directory into ~/.vscode/extensions.
- `cd ~/.vscode/extensions/obs-vscode-extension` and run `tsc` to build the extension.
- Use VSCode to open a directory containing Obsidian files.

You can use commands provided within VSCode to build and deploy an Obsidian smart contract to a local test network. You can also build and run client applications. In order to tell the extension which file contains the smart contract's main contract and which file contains the client's main transaction, you should provide a `project.json` file at the top level of your project directory. It should contain:

::

{
"chaincode": "<path-to-chaincode>",
"client": "<path-to-client>.obs"
}


Paths should be relative to the project.json file.
1 change: 1 addition & 0 deletions user_guide/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The Obsidian Smart Contract Language
Getting Started <getting_started>
Obsidian Language Tutorial <tutorial/tutorial>
Obsidian Reference <reference/reference>
Using the compiler <compiling>
Contributing to Obsidian <contributing>


Expand Down

0 comments on commit 4e31477

Please sign in to comment.