diff --git a/README.md b/README.md index 389d288..c42b7d1 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,12 @@ 1. On the first page you enter the no. of friends there are and press enter - 2. On the second page you can enter the names of all the friends , or you can press reset to start agian + 2. On the second page you can enter the names of all the friends , or you can press reset + to start agian - 3. On the third page you make entries of each payment , and you can then calculate the final result anytime ,you can even add more entries even after calculation and then again if you calculate ,new entries will be used + 3. On the third page you make entries of each payment , and you can then calculate the + final result anytime ,you can even add more entries even after calculation and then again + if you calculate ,new entries will be used 4. now if you press reset anytime you will be prompted to enter everthing again @@ -26,6 +29,12 @@ 3. open new terminal and run " npm run build " , now open public/index.html in the browser +## Prerequisets to Work on project + +- JavaScript +- Html +- CSS +- [TailwindCSS](https://tailwindcss.com/) ( just the basics ) ->[ this will sufice ](https://www.youtube.com/watch?v=G5YDmWNU_tc) ## How to Contribute to the Project ? @@ -44,11 +53,14 @@ 1. Your changes should be well commented , overcomment if you can - 2. While making changes try to be consious that you code such way that there are minimum conflict when merging + 2. While making changes try to be consious that you code such way that there are minimum + conflict when merging - 3. Be upto date with the original file as much as you can and adjustyour code accordingly first hand , so later you don't have to modify too much to clear conflicts + 3. Be upto date with the original file as much as you can and adjustyour code accordingly + first hand , so later you don't have to modify too much to clear conflicts - 4. In javascript try to use functions for changes if possible , don't just hard code to already existing code or you can have a different js file altogether , but link it well + 4. In javascript try to use functions for changes if possible , don't just hard code to + already existing code or you can have a different js file altogether , but link it well ## feautures you can work on : @@ -59,6 +71,17 @@ 3. You can make the popup which appears when you make entry to come smoothly and then disappper smoothly or it comes from one side and go to other side and disappear , **work on popup transition** +4. suggest more features in discussion section I will add them here for contributers to work on + +## Bugs you can work on + +1. At the moment I don't know if there is any bug. let me know in the discussion of this repo + + +## How to reach me ? + +- comment in the discussion section , I will get to you + @@ -69,4 +92,4 @@ -[page](https://stackoverflow.com/questions/36782467/set-subdirectory-as-website-root-on-github-pages) which showed me how to publish git pages from subfolder +### [page](https://stackoverflow.com/questions/36782467/set-subdirectory-as-website-root-on-github-pages) which showed me how to publish git pages from subfolder