Merge pull request #67 from cheonjaeung/readme

Add building, contributing section to README

Author: cheonjaeung

README.md

@@ -56,12 +56,75 @@ VerticalGrid(
 
 For more information, please visit [documentation](https://cheonjaeung.github.io/gridlayout-compose/) site.
 
+## Building
+
+This project is kotlin multiplatform project.
+It's recommended to setup kotlin multiplatform developement environment.
+
+### Samples
+
+This project contains sample app project in the `samples` directory.
+You can run sample app both Andorid and iOS (iOS sample app can run only on the macOS).
+
+### Testing
+
+This project uses snapshot testing.
+To run test, run following command:
+
+```shell
+./gradlew :grid:verifyPaparazziDebug
+```
+
+If you add test cases, run following command to create new snapshots:
+
+```shell
+./gradlew :grid:recordPaparazziDebug
+```
+
+If test is failed, you can check what is wrong from diff images.
+The diff images are generated in `grid/build/paparazzi/failures/` with `delta-*` name.
+
+### Binary Compatibility
+
+This project runs public binary API compatibility validation on CI.
+If you change public APIs, run following command before commit:
+
+```shell
+./gradlew apiDump
+```
+
+And you should commit api files with your code changes.
+
+## Contributing
+
+Welcome to contribute to this project!
+Feel free to create pull requests or issues.
+
+- **Patching**: If you want to change code, make a pull request.
+- **Bug Reporting**: If you think something is wrong, make an issue and add the **bug** label.
+- **Feature Requesting**: If you want to request some features, make an issue and add the **enhancement** label.
+- **Questions**: If you have some questions, make an issue and add the **question** label.
+
 ## Changelog
 
 Please see [changelog](./CHANGELOG.md) file.
 
 ## License
 
-Copyright 2023 Jaeung Cheon.
+```
+Copyright 2023 Cheon Jaeung
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
 
 GridLayout for Compose is licensed under Apache License 2.0. See [license file](./LICENSE.txt) for more details.