diff --git a/scripts/README.md b/scripts/README.md index c299b339d..fa8eb721a 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -30,19 +30,21 @@ Step 7 : You can commit the changes by running the following command line... `comments.sh` - it's used to generate author and problem description comments > **Notes**: -> - The `comments.sh` is compatible for both Linux and Mac platfrom. +> - The `comments.sh` is compatible for both Linux and Mac platform. > - The `comments.sh` needs [jq](https://stedolan.github.io/jq/) to grab & parse the json contents. > - The `comments.sh` currently can automatically detect the problem's type, if the problem is `algorithm` type, it's going to create `.cpp` file, if the problem is `shell` type, the `.sh` file will be created. -1) Create a file named largestNumber.cpp, and add Copyright & Problem description -```sh -./comments.sh https://leetcode.com/problems/largest-number/ -``` +1. Create a file named largestNumber.cpp, and add Copyright & Problem description -2) Add Copyright & Problem description into existed file -```sh -./comments.sh https://leetcode.com/problems/largest-number/ largestNumber.cpp -``` + ```sh + ./comments.sh https://leetcode.com/problems/largest-number/ + ``` + +2. Add Copyright & Problem description into existed file + + ```sh + ./comments.sh https://leetcode.com/problems/largest-number/ largestNumber.cpp + ``` The comments would be generated by above examples as below: