docs: Update platform docs

- Introduce a table of supported platforms in top-level README
- Add stub files for un-documented platforms using a standard template
- Update HyperKit doc to follow a standard template

Signed-off-by: Rolf Neugebauer <rolf.neugebauer@docker.com>
This commit is contained in:
Rolf Neugebauer
2017-06-10 20:42:19 +01:00
parent 341cf56795
commit db2487383a
5 changed files with 103 additions and 13 deletions

View File

@@ -47,14 +47,18 @@ You can use `linuxkit run <name>` or `linuxkit run <name>.<format> to execute th
This will use a suitable backend for your platform or you can choose one, for example VMWare.
See `linuxkit run --help`.
Additional, platform specific information is available for:
- [macOS/HyperKit](docs/platform-hyperkit.md)
- [qemu/kvm](docs/platform-qemu.md)
- [Amazon Web Services](docs/platform-aws.md)
- [Google Cloud](docs/platform-gcp.md)
- [Microsoft Azure](docs/platform-azure.md)
Currently supported platforms are:
- Local hypervisors
- [HyperKit (macOS)](docs/platform-hyperkit.md)
- [Hyper-V (Windows)](docs/platform-hyperv.md)
- [qemu (macOS, Linux, Windows)](docs/platform-qemu.md)
- [VMware (macOS, Windows)](dos/platform-vmware.md)
- Cloud based platforms:
- [Amazon Web Services](docs/platform-aws.md)
- [Google Cloud](docs/platform-gcp.md)
- [Microsoft Azure](docs/platform-azure.md)
- [packet.net](docs/platform-packet.md)
We'll add more detailed docs for other platforms in the future.
#### Running the Tests