Skip to content

Commit

Permalink
README includes more info about new line problem.
Browse files Browse the repository at this point in the history
Do you think this enough to close gdg-x#294
  • Loading branch information
tasomaniac committed Apr 3, 2015
1 parent a0e8995 commit 783730d
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,19 @@ Development

Check out project and import it to Android Studio.

This project enforces a checkstyle. The checkstyle configuration is available in `settings/checkstyle.xml` file. Please respect to the configuration. Because of the line ending difference between Unix systems and Windows, you may get checkstyle errors. If you do, please check this [help page](https://www.jetbrains.com/idea/help/handling-lf-and-crlf-line-endings.html)
###Checkstyle Integration

Image optimization is encourged for new images. You can use the [image_optim](https://github.com/toy/image_optim) tool to do it easily. Use the following to install it.
This project enforces a checkstyle. The checkstyle configuration is available in `settings/checkstyle.xml` file. Please respect to the configuration.

**Note:** Because of the line ending difference between Unix systems and Windows, you may get checkstyle errors about line endings. If you do, please check this [help page](https://www.jetbrains.com/idea/help/handling-lf-and-crlf-line-endings.html).
If you cannot resolve the issue, you can simply comment out the following line in the `checkstyle.xml` file.
```
<module name="NewlineAtEndOfFile" />
```

###Image Optimization

Image optimization is encourged for new images. You can use the [image_optim](https://github.com/toy/image_optim) tool to do it easily. Use the following command to install it.
```
gem install image_optim image_optim_pack
```
Expand Down

0 comments on commit 783730d

Please sign in to comment.