Skip to content

Commit

Permalink
Don't recommend git bash as it likes to break
Browse files Browse the repository at this point in the history
  • Loading branch information
richardebeling committed Nov 21, 2023
1 parent 06ad1d6 commit ab41436
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit ab41436

Please sign in to comment.