elm/compiler
1
1
Fork 0
mirror of https://github.com/elm/compiler.git synced 2024-10-03 22:27:11 +03:00
Code Issues Projects Releases Wiki Activity

make the npm README look nicer

Browse Source
This commit is contained in:
Evan Czaplicki 2023-11-01 16:15:26 +01:00
parent 8e4a23528d
commit 2f6dd29258
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
installers/npm/README.md
View File

@ -9,22 +9,20 @@ Head over to [The Official Guide](https://guide.elm-lang.org/) to start learning
## What is this package for?
**Normal installs** ❌
For normal installs, I reccomend using the instructions [here](https://guide.elm-lang.org/install/elm.html) instead. This package is only for people who enjoy using `npm` even when it is not necessary, or for people who want to use `npm` for certain scenarios such as:
Use the instructions [here](https://guide.elm-lang.org/install/elm.html) instead.
**Multiple versions** ✅
**Multiple versions**
People using Elm at work may use different versions of Elm in different projects. They can run `npm install elm@latest-0.19.1` in each project and use the binary at `./node_modules/.bin/elm` for compilation.
**Continuous integration** ⚠️
**Continuous integration**
This works, but there are usually faster and more reliable options:
The `npm` installer works for this, but there are faster and more reliable options:
1. You can download `elm` directly from GitHub with [this script](https://github.com/elm/compiler/blob/master/installers/linux/README.md). This is all the `npm` installer does, but with extra HTTP requests to `npmjs.com` servers, making it slower and adding more failure points.
2. Many continuous integration have ways to cache files ([example](https://docs.travis-ci.com/user/caching/)) to make builds faster and more reliable.
1. You can download `elm` directly from GitHub with [this script](https://github.com/elm/compiler/blob/master/installers/linux/README.md). This allows you to skip `npm` entirely.
2. Many continuous integration have ways to cache files ([example](https://docs.travis-ci.com/user/caching/)) to make builds faster and more reliable. This is the ideal setup.
That said, it will definitely work to use the `npm` installer on CI if you prefer that option.
That said, it works to use the `npm` installer on CI if you prefer that option.
<br/>