Skip to content

Commit 131249a

Browse files
committed
add: instructions to refer to local sistent fork
Signed-off-by: M-DEV-1 <[email protected]>
1 parent 1879b9d commit 131249a

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,31 @@ To run tests:
7171
make tests
7272
```
7373

74-
To attach sistent to your project use:
74+
#### Using your local Sistent Fork in a Project
75+
76+
1. Install your local Sistent package in the project
7577

7678
```
7779
npm install <path-to-sistent-on-local-machine>
7880
```
7981

82+
2. Build your local Sistent fork
83+
84+
After making changes to your fork, run this command in your local Sistent package.
85+
86+
```
87+
make build
88+
```
89+
90+
3. Run the build command in the project where your local Sistent fork is installed.
91+
92+
```
93+
# example, Meshery UI
94+
make ui-build
95+
```
96+
97+
Now your project should reflect changes from your local Sistent fork.
98+
8099
> [!NOTE]
81100
> Avoid using `type any` in your code. Always specify explicit types to ensure type safety and maintainability.
82101

0 commit comments

Comments
 (0)