From ab4143657705287cd5a9917cd4a235cc8a6cd260 Mon Sep 17 00:00:00 2001 From: Richard Ebeling Date: Tue, 21 Nov 2023 01:04:43 +0100 Subject: [PATCH] Don't recommend git bash as it likes to break --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9059163a1e..5b3b53f3e3 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,12 @@ The easiest setup using [Vagrant](https://www.vagrantup.com) is shown here. 1. Fork the EvaP repository (using the Fork-button in the upper right corner on GitHub). 2. Windows users only (might not apply for the Linux subsystem): - * Line endings: git's [`core.autocrlf` setting](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf) has to be `false` or `input` so git does not convert line endings on checkout, because the code will be used in a Linux VM. We suggest using this command in Git Bash: + * Line endings: git's [`core.autocrlf` setting](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf) has to be `false` or `input` so git does not convert line endings on checkout, because the code will be used in a Linux VM: ```bash git config --global core.autocrlf input ``` + * We have observed [weird](https://github.com/hashicorp/vagrant/issues/9143#issuecomment-401088752) [behavior](https://github.com/git-for-windows/git/issues/3657) with ssh in Git Bash on Windows and thus recommend using PowerShell instead. In theory, you should be able to use any command line tool. 3. Run the following commands on the command line to clone the repository, create the Vagrant VM and run the Django development server. To use Docker, replace `vagrant up` with `vagrant up --provider docker && vagrant provision`.