From c25bbadea90702dd9160ab164830dcbfb0a01523 Mon Sep 17 00:00:00 2001 From: Timid Robot Zehta Date: Wed, 25 Sep 2024 10:52:53 -0700 Subject: [PATCH 1/3] reference foundational tech --- README.md | 63 +++++++------------------------------------------------ 1 file changed, 7 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 4e528180..4f00e570 100644 --- a/README.md +++ b/README.md @@ -49,64 +49,15 @@ site (served as static files). ## Setup and Usage -Once this project's required dependencies are enabled on your system, you will -be able to run the legal-tools application and generate static files. +Once this project's required dependencies (ex. Docker, Git) are enabled on your +system, you will be able to run the legal-tools application and generate static +files. +For information on learning and installing the prerequisite technology for this +project, please see [Foundational technologies — Creative Commons Open +Source][found-tech]. -### Prerequisites - -This project depends on Docker and Git. It also requires this repository and -the data repository (the codebases) be cloned next to each other. - - -#### MacOS - -Mac users can install Git using these instructions: [Git - Installing Git - -Installing on macOS][macos-git]. - -Docker Desktop can be installed using these instructions: [Install Docker -Desktop on Mac | Docker Docs][macos-docker]. - -[macos-git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git#_installing_on_macos -[macos-docker]: https://docs.docker.com/desktop/install/mac-install - - -#### Linux - -Git is optimally installed using your distribution's package manager. See -[Git- Download for Linux and Unix][linux-git] for a wide range of popular -distros. - -Both Docker Desktop and Docker Engine are separately supported on Linux. -Both include the required Compose command plugin, but Docker Engine is -typically much easier to install: -- _Recommended:_ See [Install Docker Engine | Docker Docs][linux-docker-engine] - for links to installation instructions for Docker Engine and Compose for - various Linux distributions. -- See [Install Docker Desktop on Linux | Docker - Docs][linux-docker-desktop] for links to instructions for the graphical - desktop app that includes the commandline interface and Compose - -[linux-git]: https://git-scm.com/download/linux -[linux-docker-engine]: https://docs.docker.com/engine/install -[linux-docker-desktop]: https://docs.docker.com/desktop/install/linux-install - - -#### Windows - -You must use Windows 10 or 11 with Windows Subsystem for Linux (WSL2). For -installation instructions: see [Install WSL | Microsoft Learn][wsl2]. - -Git should be installed within WSL2, using the appropriate Linux installation -method. For WSL2 Ubuntu, the command is `sudo apt-get install git`. - -Docker Desktop should be installed on Windows itself and integrated with WSL2 -as explained in [Docker Desktop WSL 2 backend on Windows | Docker -Docs][docker-wsl2]. Unlike Git, you should not install Docker within your WSL2 -environment. - -[wsl2]: https://docs.microsoft.com/en-us/windows/wsl/install -[docker-wsl2]: https://docs.docker.com/desktop/windows/wsl +[found-tech]: https://opensource.creativecommons.org/contributing-code/foundational-tech/ ### Codebases Setup From 4a98b65dbbc6e14a1775d2c76d144794c684b2f9 Mon Sep 17 00:00:00 2001 From: Timid Robot Zehta Date: Wed, 25 Sep 2024 10:55:56 -0700 Subject: [PATCH 2/3] improve grammar --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f00e570..3d4f3cbc 100644 --- a/README.md +++ b/README.md @@ -53,8 +53,8 @@ Once this project's required dependencies (ex. Docker, Git) are enabled on your system, you will be able to run the legal-tools application and generate static files. -For information on learning and installing the prerequisite technology for this -project, please see [Foundational technologies — Creative Commons Open +For information on learning and installing the prerequisite technologies for +this project, please see [Foundational technologies — Creative Commons Open Source][found-tech]. [found-tech]: https://opensource.creativecommons.org/contributing-code/foundational-tech/ From 9892ebb88c8702962dc699e975091bb820cac797 Mon Sep 17 00:00:00 2001 From: Timid Robot Zehta Date: Wed, 25 Sep 2024 10:57:48 -0700 Subject: [PATCH 3/3] improve grammar --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3d4f3cbc..21bb51ea 100644 --- a/README.md +++ b/README.md @@ -49,9 +49,9 @@ site (served as static files). ## Setup and Usage -Once this project's required dependencies (ex. Docker, Git) are enabled on your -system, you will be able to run the legal-tools application and generate static -files. +Once this project's required dependencies (Docker, Git, etc.) are enabled on +your system, you will be able to run the legal-tools application and generate +static files. For information on learning and installing the prerequisite technologies for this project, please see [Foundational technologies — Creative Commons Open