-
Notifications
You must be signed in to change notification settings - Fork 17
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
Format the README style #50
Conversation
@@ -17,7 +17,6 @@ following features: | |||
The environment consists of scripts for building dependencies and managing | |||
them. More information will be added as the project becomes more complete. | |||
|
|||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I presume the double blank line is redundant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems my own convention. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I should communicate with the team first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you elaborate more about the convention you use? I did not see a pattern but I can be wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me initiate a discussion for the elaboration #60
@@ -60,7 +57,8 @@ more flexibility and saves significant memory. | |||
|
|||
### Running Unitest | |||
|
|||
We use `shunit2` as our unittest framework. If you want to enable unittest, please fetch your source along with `shunit2` by placing: | |||
We use `shunit2` as our unittest framework. If you want to enable unittest, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Break the long line into 2. Note that at the end of the file (line 74) the textwidth has been indicated to be 79.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good me. We could talk about the markdown convention style later in the sprint.
@@ -17,7 +17,6 @@ following features: | |||
The environment consists of scripts for building dependencies and managing | |||
them. More information will be added as the project becomes more complete. | |||
|
|||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems my own convention. :)
@@ -17,7 +17,6 @@ following features: | |||
The environment consists of scripts for building dependencies and managing | |||
them. More information will be added as the project becomes more complete. | |||
|
|||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I should communicate with the team first.
This PR only fixes the typesetting of README.