add workflow.sh in README.md

haoel · haoel · commit b8647e96b9e5 · 2021-03-22T19:22:36.000+08:00
diff --git a/scripts/README.md b/scripts/README.md
@@ -1,22 +1,46 @@
-Some Scripts
+Helpful Scripts
 ============
 
-### comments.sh
+- [Helpful Scripts](#helpful-scripts)
+  - [workflow.sh](#workflowsh)
+  - [comments.sh](#commentssh)
+  - [readme.sh](#readmesh)
+
+## workflow.sh
+
+`workflow.sh` - it's used to run a number of operations. It depends on `comments.sh` and `readme.sh`
+
+For example:
+```
+$ cd leetcode/algorithms/cpp
+$ ../../scripts/workflow.sh https://leetcode.com/problems/design-authentication-manager/
+Step 1 : Created "designAuthenticationManager" directory!
+Step 2 : Created "designAuthenticationManager/DesignAuthenticationManager.cpp" source file!
+Step 3 : Run "git add designAuthenticationManager/DesignAuthenticationManager.cpp"!
+Step 4 : Edited the "designAuthenticationManagerDesignAuthenticationManager.cpp"!
+Step 5 : Copied the readme text to Clipboard!
+Step 6 : Edited the "README.md"!
+Step 7 : You can commit the changes by running the following command line...
+
+            git commit -am "New Problem Solution -\"Design Authentication Manager\""
+```
+
+## comments.sh
 
 `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`  needs [xidel](https://github.com/benibela/xidel) to grab & parse the html  contents with filtering out the HTML tags. The script  would check the `xidel`  whether installed or not in your Linux box, if not, it will download via Github on Linux platform, and the run `brew install xidel` on Mac platfrom.
+> - 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/
 ```
 
 2) Add Copyright & Problem description into existed file
-```
+```sh
 ./comments.sh https://leetcode.com/problems/largest-number/ largestNumber.cpp
 ```
 
@@ -25,7 +49,7 @@ The comments would be generated by above examples as below:
 > **Notes**
 > If you need to customize the `Author` name, you have to change the `$AUTHOR` variable at the beginning of the scripts.
 
-```
+```cpp
 // Source : https://oj.leetcode.com/problems/largest-number/
 // Author : Hao Chen
 // Date   : 2015-01-25
@@ -45,13 +69,13 @@ The comments would be generated by above examples as below:
 
 ```
 
-### readme.sh
+## readme.sh
 
 `readme.sh` - it's used to generate the table item in README.md
 
 For example:
 
-```
+```sh
 $  ./readme.sh ../algorithms/cpp/nextPermutation/nextPermutation.cpp 
 |31|[Next Permutation](https://oj.leetcode.com/problems/next-permutation/) | [C++](./algorithms/cpp/nextPermutation/nextPermutation.cpp)|Medium|
 ```
diff --git a/scripts/workflow.sh b/scripts/workflow.sh
@@ -65,10 +65,10 @@ else
     read -n 1 -s -r -p  "Please copy the line above & press any key continue to edit README.md"
 fi
 
-echo "Step 5: Copied the readme text to Clipboard!"
+echo "Step 5 : Copied the readme text to Clipboard!"
 vi ${SCRIPTPATH}/../README.md
-echo "Step 6: Edited the \"README.md\"!"
+echo "Step 6 : Edited the \"README.md\"!"
 
-echo "Step 7: You can commit the changes by running the following command line..."
+echo "Step 7 : You can commit the changes by running the following command line..."
 echo ""
 echo "            ${commit}"
