-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added documentation on how to use a project.json file to tell the VSC…
…ode extension how to find the client and smart contract.
- Loading branch information
Showing
2 changed files
with
21 additions
and
0 deletions.
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
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. |
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