From 036c7360144e5890890feb84e579b734d2215613 Mon Sep 17 00:00:00 2001 From: Spencer Ng Date: Tue, 19 Mar 2024 14:57:25 -0700 Subject: [PATCH] Update README to have correct license --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 52905bf7..9ad98304 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,27 @@ ## SageMaker Code Editor -This is the repo for `sagemaker-code-editor`. +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 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. 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. +## Patching Execution + To properly patch, please follow instructions below: +* After cloning the repo, run `git submodule init` and `git submodule update` to initialize the `vscode` submodule. +* Use `quilt` to apply patches in sequence using `quilt push -a` from the root directory. + - Install quilt on mac - `brew install quilt` * Copy resources with the shell script (also in the root directory) by running these commands: - `chmod +x copy-resources.sh` - `./copy-resources.sh` -* Use `quilt` to apply patches in sequence using `quilt push -a` from the root directory. - - Install quilt in mac - `brew install quilt` + +The above steps will result in changes being applied to the `vscode` folder. + +## Troubleshooting and Feedback + +For any issues that customers would like to report, please route to the `amazon-sagemaker-feedback` repository: https://github.com/aws/amazon-sagemaker-feedback ## Security @@ -20,4 +29,4 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform ## License -This library is licensed under the MIT-0 License. See the LICENSE file. \ No newline at end of file +This library is licensed under the MIT License. See the LICENSE file. \ No newline at end of file