Browse code

Enhance the README to give a better overview of Photon OS

Add standard sections such as "Getting Started", "Contributing" etc.,
to the README file to make it more informative and accessible to new
users. (Note that some of this info is also available at:
vmware.github.io/photon).

Change-Id: Ib8b01d8ea2639b38895e56d7f7d92a91f19db448
Reviewed-on: http://photon-jenkins.eng.vmware.com:8082/5641
Reviewed-by: Anish Swaminathan <anishs@vmware.com>
Tested-by: Anish Swaminathan <anishs@vmware.com>

Srivatsa S. Bhat authored on 2018/09/11 07:20:30
Showing 1 changed files
... ...
@@ -1,20 +1,56 @@
1 1
 ![Photon](http://storage.googleapis.com/project-photon/vmw-logo-photon.svg "VMware Photon")
2 2
 
3
-**Welcome to VMware Photon OS: Linux Container Host**
4

                
3
+# Photon OS: Linux Container Host
5 4
 
6
-This repository is intended for developers who want to modify Photon and build their own customized ISO images or contribute to the code base.
5
+### Contents
6
+- [What is Photon OS](#what-is-photon)
7
+- [Getting Photon OS](#getting-photon)
8
+- [Getting Started](#getting-started)
9
+- [Contributing](#contributing)
10
+- [License](#license)
11
+- [Photon OS Resources](#resources)
7 12
 
8
-**Photon OS 2.0 is here!**
13
+## What is Photon OS?
14
+Photon OS&trade; is an open source Linux container host optimized for cloud-native applications, cloud platforms, and VMware infrastructure. Photon OS provides a secure run-time environment for efficiently running containers. Some of the key highlights of Photon OS are:
15
+
16
+* Optimized for VMware hypervisor: The Linux kernel is tuned for performance when Photon OS runs on VMware ESXi.
17
+
18
+* Support for containers: Photon OS includes the Docker daemon and works with container orchestration frameworks, such as Mesos and Kubernetes.
19
+
20
+* Efficient lifecycle management: Photon OS is easy to manage, patch, and update.
21
+
22
+* Security hardened: Photon OS provides secure and up-to-date kernel and other packages, and its policies are designed to govern the system securely.
23
+
24
+For an overview of Photon OS, see [https://vmware.github.io/photon/](https://vmware.github.io/photon/)
25
+
26
+## Getting Photon OS
27
+
28
+Photon OS binaries are available in a number of formats, including ISO, OVA and cloud images such as Amazon AMI, Google Cloud GCE image and Azure VHD.
29
+
30
+For download instructions and links to Photon OS binaries, go to the [Download Guide in the github wiki](https://github.com/vmware/photon/wiki/Downloading-Photon-OS).
31
+
32
+*Photon OS 2.0 is here!*
9 33
 --------------------------
10 34
 Photon OS 2.0 introduces new security and OS management capabilities, along with new and updated packages for Cloud native applications and VMware appliances. 
11 35
 
12
-- For download instructions and links to Photon OS binaries, go to the [Download Guide in the github wiki](https://github.com/vmware/photon/wiki/Downloading-Photon-OS).
13
-- For an overview of changes, see [What's New in Photon OS 2.0 in the github wiki](https://github.com/vmware/photon/wiki/What-is-New-in-Photon-OS-2.0).
36
+For an overview of changes, see [What's New in Photon OS 2.0 in the github wiki](https://github.com/vmware/photon/wiki/What-is-New-in-Photon-OS-2.0).
37
+
38
+## Getting Started
39
+Begin your Photon OS journey by browsing our extensive guides on getting started in the [Photon OS GitHub Wiki](https://github.com/vmware/photon/wiki).
40
+
41
+## Contributing
42
+The Photon OS project team welcomes contributions from the community.
43
+
44
+If you wish to contribute code and you have not signed our Contributor License Agreement (CLA), our CLA-bot will take you through the process and update the issue when you open a [Pull Request](https://help.github.com/articles/creating-a-pull-request). If you have questions about the CLA process, see our CLA [FAQ](https://cla.vmware.com/faq) or contact us through the GitHub issue tracker.
45
+
46
+To help you get started making contributions to Photon OS, we have collected some helpful best practices in the [Contributing guidelines](https://github.com/vmware/photon/blob/master/contributing.md).
47
+
48
+## License
49
+The Photon OS ISO and OVA images are distributed under the [Photon OS EULA](https://github.com/vmware/photon/blob/2.0/installer/EULA.txt).
50
+
51
+With the exception of the 'libtdnf' source code, Photon OS source code is distributed under GNU GPL v2. The 'libtdnf' source code is distributed under GNU LGPL v2.1. For more details, please refer to the [Photon OS Open Source License file](https://github.com/vmware/photon/blob/master/COPYING).
14 52
 
15
-**Photon OS Resources**
53
+## Photon OS Resources
16 54
 
17 55
 - **Documentation**: See the [Docs](docs/) folder.
18 56
 - **Security Updates**: Visit [Security-Advisories](https://github.com/vmware/photon/wiki/Security-Advisories).