search

dime-worldbank / quarto-dime-theme

DIME theme for Quarto Reveal.js Presentations
https://dime-worldbank.github.io/quarto-dime-theme/
MIT License
10 stars 3 forks source link

Add Homebrew isntructions within the description #13

Open rdoino-wb opened 9 months ago

rdoino-wb commented 9 months ago

I don't think everyone has in mind that one needs to install Quarto before uploading the theme. Instructions do not mention anything about it but they just tell you to use that command in the terminal. If they do not have quarto already installed, then the command won't be found.

Homebrew offers an easy way to install quarto, I would add this reference and a short instruction, such as:

Getting Started with Quarto on macOS

To get started with using this theme for your Quarto projects, you'll first need to install Quarto on your macOS system. The recommended way to install Quarto is through Homebrew, which is a package manager that simplifies the installation of software on macOS. Follow the simple steps below to install Quarto and begin using the theme.

Installation Instructions

  1. Open your Terminal application to begin the installation process.
  2. If Homebrew is not already installed on your machine, you can install it by executing the following command in the Terminal: 
    
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  3. Once you have Homebrew installed, you can install Quarto by running the following command: 
    
brew install quarto
kbjarkefur commented 9 months ago

@rdoino-wb, it is a good point that our README does not mention anything about how to install quarto. However, my experience from other repos with software prerequisites is that instructions like this can become outdated and then it is more confusing than helpful.

I still think your point is valid. Especially that we should explicitly mention that some software installation is needed before this theme might run. But I think it is better to link to a page with instructions rather than including instructions that we need to make sure is up to date.

I think we should link to this page: https://quarto.org/docs/get-started/. But the homebrew installation method is not listed there. Do you have a good stable link for that we can use as well?