theexidge / routinger

Routinger is a task scheduler app that is made to make you a better person at no extra cost. The code is open-source. Dart language and Flutter framework are used extensively.
GNU Affero General Public License v3.0
27 stars 22 forks source link

Updating Readme to make it more informative #1

Closed Kushalrock closed 3 years ago

Kushalrock commented 3 years ago

README.md is very vague and doesn't clearly imply:

  1. How the code works?
  2. The general workflow

It can be made more informative and easier to read to help newcomers to understand it better.

arnav1776 commented 3 years ago

I would like to work on this issue, quick query should I make pr after Hacktober fest starts or before?

Kushalrock commented 3 years ago

Sure why not. I am assigning the task to you. If you want your PR to be counted for hacktoberfest. You should make the PR after hacktoberfest starts. I would recommend that you fork the repository now, do the required changes and then make a PR on October 1 that will be much more effective.

arnav1776 commented 3 years ago

Ok thanks, will do.

Kushalrock commented 3 years ago

@arnav1776 Please take these two images and write in the readme about the old look and new look of the app. oldlook Screenshot_1633023644

The first one is the old look and the second one is the fresh look and give all the credit to @AyoubBoulahtar who helped us revamp our look.

P.S. trim the edges of the images do not include the buttons from the screenshot.

arnav1776 commented 3 years ago

@Kushalrock please check out the readme that I had created till now based on the old looks https://github.com/arnav1776/routinger/blob/readme/README.md & do you want me to update it with new images or should I add both the looks in it, also suggest any changes you'd like me to work on.

Kushalrock commented 3 years ago

It looks good. I am recommending a few changes like removing the sponsor project screen. In the add task screen select the scheduled task and click a photo of it and use it.

Regarding where to implement new looks use the pictures of new look in readme(replace the old look images) and yes take one of the pictures of old look and write in readme that we have changed our app looks.

Also please update the dependencies. Yesterday, after three merges we are using more dependencies.

[Optional] We want people to know how the project works. So if you have like a better idea. Like if we see the readme now it just shows the folder structure and dependencies. Something else which could make it informative like including that this file contains these functions and so on. Please also include that.

If you're planning on including this do so in a separate commit. So that you can revert back.

arnav1776 commented 3 years ago

Okay and can you please mail me all the screenshots to be included on arnav1776@gmail.com because my emulator is not running properly so I am having some trouble running it.

Kushalrock commented 3 years ago

Yeah sure I will do that in a few hours @arnav1776

arnav1776 commented 3 years ago

@Kushalrock I have updated everything except the images part please check it.

Kushalrock commented 3 years ago

It looks really good. Just update the images. For now, remove the dark mode and yes wherever you are adding the add task screen don't use the to-do drop down instead use the scheduled task to help people notice the vast array of options available to them.

@arnav1776

arnav1776 commented 3 years ago

I had asked you to send me the images as my emulator wasn't working properly😅, that's why I had to leave the images part also please send the scheduled task which you have mentioned.

Kushalrock commented 3 years ago

Oh I am really sorry. I forgot, I will send you those in like 8-10 hours. Really sorry...

Kushalrock commented 3 years ago

Here are the images Screenshot_1633023644 Screenshot_1633150130 Screenshot_1633150137 Screenshot_1633150143 Screenshot_1633150149 Screenshot_1633150161 Screenshot_1633150189

Kushalrock commented 3 years ago

@arnav1776 Please check the images

Kushalrock commented 3 years ago

I have also sent you the images in your email from helproutinger@gmail.com

arnav1776 commented 3 years ago

Thank you for sending, I will update it and open a pr.

Kushalrock commented 3 years ago

Sure. No need for thanks. In fact, I should thank you, your help and contribution are more than appreciated.

Kushalrock commented 3 years ago

@arnav1776 You did a great job. I just saw your Word press portfolio too it was awesome.

We are looking forward to creating a website for routinger with react. Would you like to join hands with us??

arnav1776 commented 3 years ago

Sure I would love to work on the project but I only know the basics of react as I had only recently started learning it.

Kushalrock commented 3 years ago

If you have any other suggestions. We are all ears.