Added README.md

README.md

@@ -0,0 +1,41 @@
+# Upstream Linux 3.10 LTS for Chromebook NVIDIA Tegra K1 (T124) SoC devices
+
+## Description
+
+The NVIDIA Jetson TK1 development board and Chromebooks with a starting codename of "Nyan" share a lineage and similarity in where the SoC featured is an 32-bit ARM NVIDIA Tegra K1 (T124).  This allows for desktop Linux to deployed on Tegra K1 SoC Chromebooks with Jetson TK1's Linux for Tegra (L4T) userspace components; critical for features such as OpenGL and OpenGL ES graphics acceleration.
+
+As of the creation of this Git repository, mainline Linux support is incomplete for the Tegra K1 SoC.  A prominent example is the open source Nouveau graphics and it's lack of basic functionality and usability due to ongoing upstream bitrot.
+
+Given the state of  mainline Linux support for the Tegra K1 SoC and device-specific support for Chromebooks with the Tegra K1 SoC, this Git repository was created in an effort to make the vendor kernel (originally shipped with ChromiumOS) based on Linux Long-Term Support (LTS) 3.10, workable and suitable for modern desktop Linux.
+
+## Goals
+
+The Linux Long-Term Support (LTS) 3.10 kernel fork has the following goals that have are either currently a work-in-progress, completed, or planned:
+
+- Upstreaming the vendor kernel to 3.10.108 LTS; the final release of Linux LTS 3.10
+- Newer updated kernel space AppArmor by UBports
+- Backported security patches, including CVE patches
+- Backported system calls from newer Linux kernels (e.g. memfd_create)
+- Several general quality of life improvement patches (e.g. swap support)
+- Support for building the kernel with newer compilers
+
+## Notes
+
+With this kernel, the NVIDIA Linux for Tegra (L4T) userspace X11 graphics driver is functional and has been tested, but only if the X11 server release is older than the 1.19.0 due to incompatibility changes introduced in the 1.19 series X11 server.  A patched upstream X11 server with support for the NVIDIA Linux for Tegra (L4T) userspace X11 graphics driver will be released in the future.
+
+If the Mate desktop environment is used with the Compiz compositor, triple buffering must be enabled in the X11 configuration file in order to avoid graphical artifacting during general use.
+
+Kernel patches applied or referenced from multiple community projects (more information can be found at "Credits and Sources").
+
+## Credits and Sources
+
+| Repository                                                  | Branch                                                         | Organization/Individual |
+|-------------------------------------------------------------|----------------------------------------------------------------|--------------|
+| [kernel](https://chromium.googlesource.com/chromiumos/third_party/kernel) | [chromeos-3.10](https://chromium.googlesource.com/chromiumos/third_party/kernel/+/chromeos-3.10)       | Google
+| [kernel_patches/0001-LinuxIncrementals/3.10](https://gitlab.com/divested-mobile/kernel_patches/-/tree/master/0001-LinuxIncrementals/3.10) | [master](https://gitlab.com/divested-mobile/kernel_patches/-/tree/master/0001-LinuxIncrementals/3.10) | IratePorcupine (DivestOS Mobile)
+| [PKGBUILDs/core/linux-nyan](https://github.com/RaumZeit/PKGBUILDs/tree/master/core/linux-nyan) | [master](https://github.com/RaumZeit/PKGBUILDs/tree/master/core/linux-nyan) | Ronny Lorenz (RaumZeit)
+| [pmaports/device/.shared-patches/linux](https://gitlab.postmarketos.org/postmarketOS/pmaports/-/tree/master/device/.shared-patches/linux) | [master](https://gitlab.postmarketos.org/postmarketOS/pmaports/-/tree/master/device/.shared-patches/linux) | postmarketOS
+| [pmaports/device/testing/linux-samsung-klte/0010-Backport-shm-add-sealing-API.patch](https://gitlab.postmarketos.org/postmarketOS/pmaports/-/blob/4929c227edf935b3d62cc9c4643f8dc5efa44fe5/device/testing/linux-samsung-klte/0010-Backport-shm-add-sealing-API.patch) | [4929c22](https://gitlab.postmarketos.org/postmarketOS/pmaports/-/blob/4929c227edf935b3d62cc9c4643f8dc5efa44fe5/device/testing/linux-samsung-klte/0010-Backport-shm-add-sealing-API.patch) | postmarketOS
+
+## Linux Kernel Default README
+[README](README)