Skip to content

Comments

Update 'Getting Started' guide to include new installation methods#299

Closed
mbbx6spp wants to merge 1 commit intopurescript:masterfrom
mbbx6spp:mbbx6spp/add-homebrew-and-nix-to-getting-started
Closed

Update 'Getting Started' guide to include new installation methods#299
mbbx6spp wants to merge 1 commit intopurescript:masterfrom
mbbx6spp:mbbx6spp/add-homebrew-and-nix-to-getting-started

Conversation

@mbbx6spp
Copy link
Contributor

Updates 'Getting Started' guide with different subsections for existing and new methods of installation, including:

  • Using NPM
  • Downloading Binaries
  • Homebrew
  • Nix

@mbbx6spp
Copy link
Contributor Author

Related to purescript/purescript.github.io#141 which I will be modifying momentarily to account for this change.

mbbx6spp pushed a commit to mbbx6spp/purescript.github.io that referenced this pull request Feb 29, 2020
@hdgarrood
Copy link
Collaborator

I’m not sure about this one; personally, I’m most concerned about the users who don’t know or care what all of these different install options are, and I definitely don’t want to overload them with information they don’t know what to do with and present them with choices they aren’t equipped to make. Of course this information should be recorded somewhere, but the purpose of this guide is to help people get a basic setup working with absolutely minimal fuss, so I am not sure here is the correct place. There’s INSTALL.md in the compiler right now, which covers alternative installation methods to some extent, but that is admittedly very easy to overlook.

@mbbx6spp
Copy link
Contributor Author

mbbx6spp commented Mar 2, 2020

@hdgarrood would it make sense for me to relocate these new install methods in the INSTALL.md of the compiler and link to there from this document for those interested?

@hdgarrood
Copy link
Collaborator

Yes, that sounds good to me.

hdgarrood pushed a commit to purescript/purescript.github.io that referenced this pull request Apr 13, 2020
… and link to Spago (#141)

* Add instructions on how to install purescript from Homebrew and Nix

Co-Authored-By: Nathan Faubion <natefaubion@users.noreply.github.com>

* Remove 'and Yarn' from recommendation on how to manage JS dependencies

* Remove Homebrew and Nix instructions from front page per purescript/documentation#299

Co-authored-by: Susan Potter <sp721@ntrs.com>
Co-authored-by: Nathan Faubion <natefaubion@users.noreply.github.com>
Comment on lines +25 to +29
#### Using Nix

You'll need [Nix](https://nixos.org/nix/) installed with a recent version of `nixpkgs` (19.09):

nix-env -i purescript
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May I suggest also adding easy-purescript-nix? Just starting learning PureScript, and it has everything a beginner needs (or any PS dev for that matter) - plus nothing is broken as it pins nixpkgs. This stackoverflow thread is a perfect summary how confusing the PS eco-system for a new-comer, adding NixOS to mix as well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be worth mentioning it not just in INSTALL.md but somewhere here in this documentation repo, because easy-purescript-repo sets up a(n almost) complete development environment with the "recommended" utilities.

@thomashoneyman
Copy link
Member

This also relates to #323

@hdgarrood
Copy link
Collaborator

We're going to use INSTALL.md in the compiler repo to discuss other installation methods, so I'll close this. As far as I can tell, the compiler's INSTALL.md covers all of the mentioned resources apart from Nix (which I am open to taking a PR for).

@hdgarrood hdgarrood closed this Sep 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants