Skip to content

Commit 34ac4c7

Browse files
authored
Merge pull request #23 from aws/readme-update
Update README to have correct license
2 parents fad3e54 + 036c736 commit 34ac4c7

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
11
## SageMaker Code Editor
22

3-
This is the repo for `sagemaker-code-editor`.
3+
This is the repo for `sagemaker-code-editor`. For more information on Code Editor on SageMaker, please refer to: https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html
44

55
The `patched-vscode` folder's only usage is to help reviewers review the patch changes. To ease reviewing patches (`.diff` files), whenever we raise a PR for adding/updating a patch, we will also apply the patches to this directory so that this folder's diff shows up in the PR.
66

77
Whenever we create a new branch with `vscode` pointing to a specific commit, this folder must be populated with the same contents as `vscode` at that particular commit.
88

9+
## Patching Execution
10+
911
To properly patch, please follow instructions below:
1012

13+
* After cloning the repo, run `git submodule init` and `git submodule update` to initialize the `vscode` submodule.
14+
* Use `quilt` to apply patches in sequence using `quilt push -a` from the root directory.
15+
- Install quilt on mac - `brew install quilt`
1116
* Copy resources with the shell script (also in the root directory) by running these commands:
1217
- `chmod +x copy-resources.sh`
1318
- `./copy-resources.sh`
14-
* Use `quilt` to apply patches in sequence using `quilt push -a` from the root directory.
15-
- Install quilt in mac - `brew install quilt`
19+
20+
The above steps will result in changes being applied to the `vscode` folder.
21+
22+
## Troubleshooting and Feedback
23+
24+
For any issues that customers would like to report, please route to the `amazon-sagemaker-feedback` repository: https://github.com/aws/amazon-sagemaker-feedback
1625

1726
## Security
1827

1928
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
2029

2130
## License
2231

23-
This library is licensed under the MIT-0 License. See the LICENSE file.
32+
This library is licensed under the MIT License. See the LICENSE file.

0 commit comments

Comments
 (0)