diff --git a/README.md b/README.md index 84646a9..1a72739 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,60 @@ Make intuitve pixel art in this simple drawing tool written in _vanilla javascri | color swap | C | +## Launching and Running +Get the source code locally by navigating to your desired directory. +Clone the repositry using the following command: +```bash +git clone https://github.com/Kully/pixel-paint.git +``` +Open the pixel-paint folder in the newly cloned folder. +Launch index.html locally. It should open a tab in your broswer. +The program is now running locally! Go and create your own art! + + ## Contributing One of the joys of posting this project on Github is to get people excited and wanting to contribute to them. Feel free to create Pull Requests for any changes that you think the app could benifit from, or something that you would like to use. Have a look at some of the [Issues](https://github.com/Kully/pixel-paint/issues) in the repo. If you see something you want to add or comment on, by all means do so! +How to Contribute: +1. Fork the repository. +2. Click on the "Clone" button and copy your unique link. It should look something like: + ```bash + https://github.com//pixel-paint + ``` +3. Clone the repo: + ``` bash + git clone https://github.com//pixel-paint + ``` +4. Navigate inside the cloned repo: + ```bash + cd pixel-paint + ``` +4. Create a new branch: + ```bash + git checkout -b + ``` +5. Make changes and add your new features/improvements you think benefits the app. Have fun and be creative! +6. Add the newly edited files to git: + ```bash + git add . + ``` + Note: This command adds all edited files to be commited. To commit specific files, see this [git documentation](https://git-scm.com/docs/git-add). +7. Commit your changes: + ```bash + git commit -m "Detailed description of changes" + ``` +8. Push your code to your branch: + ```bash + git push origin + ``` +9. Create your Pull Request: + - In your forked repo, click the green button labeled "Compare & pull request" + - Create a clear title with detailed descriptions of your changes + - Click the green button "Create pull request" to create the PR + - Congratulations your PR has been created! +10. Wait until feedback comes and for it to get reviewed! + Have fun and be creative! :art: