Foodsoft/foodsoft
1
1
Fork 0
Code Issues 36 Pull requests 5 Projects 1 Releases Wiki Activity

Add warning about Windows line-endings issues to docs

Browse source
This commit is contained in:
Harald Reingruber 2019-11-11 12:59:39 +01:00 committed by Patrick Gansterer
parent 9babb6cfe9
commit 9897c1056f
2 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/SETUP_DEVELOPMENT.md
View file

@ -29,6 +29,11 @@ If instead you just want to run Foodsoft without changing its code, please refer
unfinished parts. If you want to be safe, choose the last release: unfinished parts. If you want to be safe, choose the last release:
`git checkout $(git tag -l | grep ^v | sort -rn | head -n1)` `git checkout $(git tag -l | grep ^v | sort -rn | head -n1)`
*Note:* When developing on Windows you might run into issues with shell scripts
because of Git auto-crlf. Have a look how to avoid that in the
[Docker Development Setup](./SETUP_DEVELOPMENT_DOCKER.md#prerequisites-windows-only)
instructions.
1. Install RVM and Ruby 2.4+ (if you have not done so before): 1. Install RVM and Ruby 2.4+ (if you have not done so before):
\curl -L https://get.rvm.io | bash \curl -L https://get.rvm.io | bash
@ -182,3 +187,4 @@ within a docker image. While the default [`Dockerfile`](../Dockerfile) is setup
use docker-compose (using [`docker-compose-dev.yml`](../docker-compose-dev.yml)) to use docker-compose (using [`docker-compose-dev.yml`](../docker-compose-dev.yml)) to
setup the whole stack at once. setup the whole stack at once.
See [Setup Development Docker](./SETUP_DEVELOPMENT_DOCKER.md) for a detailed description.

9
doc/SETUP_DEVELOPMENT_DOCKER.md
View file

@ -17,6 +17,15 @@ For installing instructions see https://docs.docker.com/installation/.
Docker runs on every modern Linux kernel, but also with a little help on MacOS Docker runs on every modern Linux kernel, but also with a little help on MacOS
and Windows! and Windows!
## Prerequisites (Windows only)
To avoid line-ending issues with shell scripts, make sure to configure
Git autocrlf to keep linux line endings via
git config --local core.autocrlf input
Don't forget to do a clean checkout (delete everything except `.git` directory)
afterwards.
## Setup ## Setup
Then setup foodsoft development (this will take some time, containers needs Then setup foodsoft development (this will take some time, containers needs