summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d4b9422
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# Jetpack Camera App ๐Ÿ“ธ
+
+This repository contains Jetpack Camera App. It's a work in progress ๐Ÿšง.
+
+Jetpack Camera App is (will be) a fully functional camera app, focused on features used by
+app developers, and built entirely with CameraX, Kotlin and Jetpack Compose. It follows Android
+design and development best practices and it's intended to be a useful reference for developers.
+
+This repository is currently in early development, and will go through many changes.
+
+# Development Environment โš’๏ธ
+
+This project uses the gradle build system, and can be imported directly into Android Studio.
+
+# Architecture ๐Ÿ“
+
+TBD
+
+# Testing ๐Ÿงช
+
+TBD
+
+
+## Source Code Headers
+
+Every file containing source code must include copyright and license
+information. This includes any JS/CSS files that you might be serving out to
+browsers. (This is to help well-intentioned people avoid accidental copying that
+doesn't comply with the license.)
+
+Apache header:
+
+ Copyright (C) 2023 The Android Open Source Project
+
+ 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.