Update README.md #255
Update README.md #255
Conversation
I have made a refined and visually engaging version of your README for Cherry On Tech’s website, with enhanced structure, clarity, and more emojis
✅ Deploy Preview for cherryontech ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
This PR doesn't fix any issues, and it introduces a couple of new ones. If you'd like to contribute, we'd prefer you do things like fix, update, or create dictionary entries, as outlined in CONTRIBUTING.md.
However, I understand it's the end of Hacktoberfest, so I've left the PR open. You're welcome to make the requested changes and request another review. Best of luck with the rest of Hacktoberfest!
| ## Contributing | ||
|
|
||
| We welcome you to contribute to our "Tech Dictionary," where we share tech terms from different _perspectives_. To get involved, read [CONTRIBUTING.md](CONTRIBUTING.md). |
There was a problem hiding this comment.
Issue: This is a very important section and should not be removed.
| 1. Make sure you have [node](https://nodejs.org/) installed. You can check by running `node --version` | ||
| 1. Install Gridsome CLI tool if you don't have it: `npm install --global @gridsome/cli` or `yarn global add @gridsome/cli` | ||
| 1. Clone the repo: `git clone https://github.com/cherryontech/website.git` | ||
| 1. `cd website` | ||
| 1. `npm install` or `yarn install` | ||
| 1. Run `gridsome develop` to start a local dev server. In the terminal, you will see an address such as `http://localhost:8080/`. Navigate to that address in a browser to see the project in action. |
There was a problem hiding this comment.
Issue: The installation steps are important to remain here. If you'd like to enhance this section by moving the node check instructions (as you added on ln15), feel free to do that.
I have made a refined and visually engaging version of your README for Cherry On Tech’s website, with enhanced structure, clarity, and more emojis
This PR fixes...
Remove the example below. Then, add the related issue after the hash. Lastly, tell us what problems this PR is meant to solve.
Ex: This PR fixes #999. We didn't have a unicorn, so we went to the unicorn store and got one.
What I did...
Remove the example below. Then, list out the work you have done, in bullet form.
Ex:
How to test...
In a list format, tell us how to test this PR.
Ex:
I learned...
Did you run into any interesting issues while making this PR? If you learned anything you would like to share, we'd love to know! Even if it is a fun fact or GIF!