search

sarthakpranesh / CpuRoller

Simple CPU usage desktop application available on Windows, Mac OS and Linux, built with Wails (made under #100DaysOfCode challenge)
MIT License
23 stars 6 forks source link

Doc: Add development commands in readme's "For Developer" section #1

Closed sarthakpranesh closed 3 years ago

sarthakpranesh commented 3 years ago

Issue

The current documentation in readme.md under the For Developer section helps the developers compile the app directly into an executable file which does not allow the developer to see changes in real-time as they change the codebase


Changes required

Update the For Developer section and move points 4 & 5 to a sub-section called Compile/Build/Package app and in place of them add wails serve, cd frontend, yarn install and yarn start commands


Make sure to fork the repo and work on the fork under a new branch. Once all your changes are complete, open a PR to the master branch of this repo

pssingh21 commented 3 years ago

Hi! I would like to work on this.

sarthakpranesh commented 3 years ago

Hi @pssingh21, please feel free to open a pr resolving this issue and make sure to work on a fork. Happy hacking 🚀