File tree 3 files changed +24
-4
lines changed 3 files changed +24
-4
lines changed Original file line number Diff line number Diff line change
1
+ # Don't track the Node.js installation artifacts
2
+ /node_modules /
3
+ /package-lock.json
Original file line number Diff line number Diff line change @@ -55,14 +55,25 @@ npm install --save https://github.com/HatScripts/circle-flags
55
55
56
56
## Contributing
57
57
58
- To contribute, you need to have the latest version of [ svgo] ( https://github.com/svg/svgo ) installed.
58
+ ### Initial setup
59
+
60
+ To contribute, you need to have the [ Node.js] ( https://nodejs.org ) JavaScript runtime installed,
61
+ and the latest version of [ svgo] ( https://github.com/svg/svgo ) .
62
+ Once Node.js is set up, you can run the following command to install ` svgo ` in the circle-flags project directory:
63
+
64
+ ``` sh
65
+ npm install
66
+ ```
67
+
68
+ ### Making changes
59
69
60
70
First, edit the relevant SVG files in the ` flags/ ` directory.
61
71
62
- Then run ` svgo ` to optimize the SVG files:
72
+ Then run the ` svgo ` wrapper script (defined in the ` scripts ` section of [ package.json] ( ./package.json ) ),
73
+ which uses the locally-installed ` svgo ` executable to optimize the SVG files:
63
74
64
75
``` sh
65
- svgo ./flags --recursive --config= svgo.config.js
76
+ npm run svgo
66
77
```
67
78
68
79
Then commit the changes, and submit them as a pull request.
Original file line number Diff line number Diff line change 33
33
"bugs" : {
34
34
"url" : " https://github.com/HatScripts/circle-flags/issues"
35
35
},
36
- "homepage" : " https://github.com/HatScripts/circle-flags#readme"
36
+ "homepage" : " https://github.com/HatScripts/circle-flags#readme" ,
37
+ "devDependencies" : {
38
+ "svgo" : " ^3.0.2"
39
+ },
40
+ "scripts" : {
41
+ "svgo" : " node_modules/.bin/svgo ./flags --recursive --config=svgo.config.js"
42
+ }
37
43
}
You can’t perform that action at this time.
0 commit comments