Skip to content

Commit

Permalink
Update README to have correct license
Browse files Browse the repository at this point in the history
  • Loading branch information
aws-spenceng committed Mar 19, 2024
1 parent fad3e54 commit 036c736
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,32 @@
## 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

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

## License

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

0 comments on commit 036c736

Please sign in to comment.