From 6bcd2144a70c55855a6a66f70ad5ca3a6a399606 Mon Sep 17 00:00:00 2001 From: Jamie Alessio Date: Mon, 2 Mar 2020 03:22:19 +0000 Subject: [PATCH] Update INSTALL.md to reference Docker as an option --- INSTALL.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 321e00987..4239ca267 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -3,12 +3,17 @@ These instructions are designed for setting up The Rails Port for development and testing. If you want to deploy the software for your own project, then see the notes at the end. -You can install the software directly on your machine, which is the traditional and probably best-supported approach. However, there is an alternative which may be easier: Vagrant. This installs the software into a virtual machine, which makes it easier to get a consistent development environment and may avoid installation difficulties. For Vagrant instructions, see [VAGRANT.md](VAGRANT.md). +You can install the software directly on your machine, which is the traditional and probably best-supported approach. However, there +are two alternatives which make it easier to get a consistent development environment and may avoid installation difficulties: + +* **Vagrant** This installs the software into a virtual machine. For Vagrant instructions see [VAGRANT.md](VAGRANT.md). +* **Docker** This installs the software using containerization. For Docker instructions see [DOCKER.md](DOCKER.md). These instructions are based on Ubuntu 20.04 LTS, which is the platform used by the OSMF servers. The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX -We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then try developing this software using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md). +These instructions are based on Ubuntu 18.04 LTS, which is the platform used by the OSMF servers. +The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX. ## Dependencies -- 2.39.5