Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reformat Readme #140

Open
wants to merge 1 commit into
base: c_in_refine
Choose a base branch
from
Open

Reformat Readme #140

wants to merge 1 commit into from

Conversation

padamchopra
Copy link

Updated the readme by resizing screenshots and using markdown formatting for bullet points to make it more readable and easy to comprehend.

Signed off by Padam Chopra

1)Download the zip file from the repository at
https://github.com/scorelab/kute/tree/c_in_refine or,use the following git command to clone the file
- Download the zip file from the repository at
https://github.com/scorelab/kute/tree/c_in_refine oruse the following git command to clone the file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a missing space between "or use".

1)Download the zip file from the repository at
https://github.com/scorelab/kute/tree/c_in_refine or,use the following git command to clone the file
- Download the zip file from the repository at
https://github.com/scorelab/kute/tree/c_in_refine oruse the following git command to clone the file
> git clone https://github.com/scorelab/kute.git
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we change this to a code?
git clone https://github.com/scorelab/kute.git

> git clone https://github.com/scorelab/kute.git

2)Next set up Android Studio on your device,using the following link
- Next set up Android Studio on your device,using the following link
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a space after the comma.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also please make sure to stop all sentences with a period. :)


6)The project will build automatically,there might be some errors but android studio will provide you with the problem and even give you an option to install the required components causing the error.
- The project will build automatically,there might be some errors but android studio will provide you with the problem and even give you an option to install the required components causing the error.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you make this as follows?

  • The project should build automatically. If there were any errors, the android studio will provide you with problems and options to install the required components causing the error.


8)Wait for the emulator to start up and turn on,later the APK file will install automatically
- Wait for the emulator to start up and turn on,later the APK file will install automatically
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a space after the comma.

Copy link
Collaborator

@vihanga-liyanage vihanga-liyanage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please find the inline comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants