Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 2.08 KB

SETUP.md

File metadata and controls

37 lines (32 loc) · 2.08 KB

Setup

TLDR: install nix, run commands/start, and everything will be auto installed

For Windows

  • Get WSL (Windows Subsystem for Linux) or WSL2
    • If you're not familiar with WSL, I'd recommend watching a quick thing on it like this one
    • Ubuntu 18.04 for WSL is preferred (same as in that linked video), but Ubuntu 20.04 or similar should work.
    • WSL2 (just released August 2020) is needed if you want to use your GPU.
  • Once WSL is installed (and you have a terminal logged into WSL) follow the Mac/Linux instructions below.
  • (protip: use the VS Code terminal instead of CMD when accessing WSL)

For Mac/Linux

  • Install nix, more detailed guide here
    • Just run the following in your console/terminal app
      • sudo apt-get update 2>/dev/null
      • If you're on MacOS Big Sur
      • If you're on MacOS Catalina, run:
        • sh <(curl -L https://nixos.org/nix/install) --darwin-use-unencrypted-nix-store-volume
      • If you're not, run:
        • curl -L https://nixos.org/nix/install | bash
      • source $HOME/.nix-profile/etc/profile.d/nix.sh
      • (may need to restart console/terminal)
  • Install git
    • (if you don't have git just run nix-env -i git)
  • Clone/Open the project
    • cd wherever-you-want-to-save-this-project
    • git clone https://github.com/*this-repo-url*
    • cd *this-repo*
  • Actually run some code
    • run commands/start to get into the project environment
      • Note: this will almost certainly take a while the first time because it will auto-install exact versions of everything: node, python, ruby, all modules for them, etc
    • run project commands to list the project commands