search

agnivabasak / Quotes

0 stars 0 forks source link

Doc: Add documentation readme.md file #3

Open sarthakpranesh opened 4 years ago

sarthakpranesh commented 4 years ago

Create a readme.md file and make sure to include the following sections or sections similar to them

  1. Introduction - short intro about the app
  2. For Developer - steps required to build the app
  3. Features
  4. Issues

You can follow this for reference if you need any


Make sure to fork the repo and work in a new branch. After you are done open a PR to the develop branch of the main repo

ankitksh81 commented 4 years ago

Hi @sarthakpranesh, can you tell me do we have to make the readme same as shown in the reference ?

sarthakpranesh commented 4 years ago

Hi @ankitksh81, no it need not be the same as the reference. But make sure to include the 4 sections mentioned and the formating should be more or less the same. If you are working on this issue make sure you fork the repo and work on the fork under a new branch. Happy hacking :v:

ankitksh81 commented 4 years ago

Where can I find the required information about the app and features ?

ankitksh81 commented 4 years ago

Let me know, I would like to work on this issue.

sarthakpranesh commented 4 years ago

Well nothing is documented yet regarding the app so all I can provide you is the following

Introduction - a simple react native app used to display daily quotes to refresh the users with an innovative design Development - you can use the reference it is more or less the same Features - it would be best if you can build the app locally and list these down Issues - would be more or less the same as in the reference

Also, the app uses unquote-api

You can ping me or @agnivabasak for more info or help here

ankitksh81 commented 4 years ago

Ok, You can assign me for this issue

ankitksh81 commented 4 years ago

Hi @sarthakpranesh, Can you please provide any document having the feature lists because I am not able to run the app using my pc. I have tried a lot but no success.

sarthakpranesh commented 4 years ago

Hey @ankitksh81, what you can do is just create the formatted table as in the reference (with the headings) and leave the features for now. We can document that later on. This way it will be simpler I guess.

ankitksh81 commented 4 years ago

Sure @sarthakpranesh that would work.