chore: Move everything into package/ (#1745)
* Move everything into package * Remove .DS_Store * Move scripts and eslintrc to package * Create CODE_OF_CONDUCT.md * fix some links * Update all links (I think) * Update generated docs * Update notice-yarn-changes.yml * Update validate-android.yml * Update validate-cpp.yml * Delete notice-yarn-changes.yml * Update validate-cpp.yml * Update validate-cpp.yml * Update validate-js.yml * Update validate-cpp.yml * Update validate-cpp.yml * wrong c++ style * Revert "wrong c++ style" This reverts commit 55a3575589c6f13f8b05134d83384f55e0601ab2.
This commit is contained in:
26
package/android/README.md
Normal file
26
package/android/README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# android
|
||||
|
||||
This folder contains the Android-platform-specific code for react-native-vision-camera.
|
||||
|
||||
## Prerequesites
|
||||
|
||||
1. Install ktlint
|
||||
```sh
|
||||
brew install ktlint
|
||||
```
|
||||
|
||||
## Getting Started
|
||||
|
||||
It is recommended that you work on the code using the Example project (`example/android/`), since that always includes the React Native header files, plus you can easily test changes that way.
|
||||
|
||||
You can however still edit the library project here by opening this folder with Android Studio.
|
||||
|
||||
## Committing
|
||||
|
||||
Before committing, make sure that you're not violating the Kotlin codestyles. To do that, run the following command:
|
||||
|
||||
```bash
|
||||
yarn check-android
|
||||
```
|
||||
|
||||
This will also try to automatically fix any errors by re-formatting the Kotlin code.
|
||||
Reference in New Issue
Block a user