File tree Expand file tree Collapse file tree 1 file changed +37
-0
lines changed
Expand file tree Collapse file tree 1 file changed +37
-0
lines changed Original file line number Diff line number Diff line change 1+ ## Setting up the environment
2+
3+ To set up the repository, run:
4+
5+ ``` sh
6+ $ ./scripts/bootstrap
7+ $ ./scripts/build
8+ ```
9+
10+ This will install required dependencies and build the SDK.
11+
12+ ## Modifying/Adding code
13+
14+ Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
15+ result in merge conflicts between manual patches and changes from the generator. The generator will never
16+ modify the contents of the ` examples/ ` directory.
17+
18+ ## Using the repository from source
19+
20+ To use a local version of this library from source in another project, add it using a directory reference:
21+
22+ ``` sh
23+ $ dotnet add reference /path/to/sdk/src/Orb
24+ ```
25+
26+ ## Formatting and linting
27+
28+ ``` sh
29+ $ ./scripts/format
30+ $ ./scripts/lint
31+ ```
32+
33+ ## Running tests
34+
35+ ``` sh
36+ $ ./scripts/test
37+ ```
You can’t perform that action at this time.
0 commit comments