Readme changes (#295)

* RStudio - > posit, mention html cheatsheets

* Add brief HTML instructions to CONTRIBUTING

* Add note about website to README

.github/CONTRIBUTING.md

@@ -33,3 +33,10 @@ We ask that you include:
 * Your translated Keynote or PowerPoint file
 
 Cheatsheet pull requests and issues tend be handled in bursts, and we may wait for several to accumulate before sorting through them so don't worry if your submission sits for a while!
+
+## HTML cheatsheets
+
+If you wish to provide an HTML cheatsheet version, please create a Pull Request 
+with a new `.qmd` file in the `html/` directory of this repository. Use one of 
+the existing `qmd` files there as a starting point/template. These should not be duplicates of the pdf versions - they should be text-based so they are more accessible
+to people with visual impairments. Use of images should be minimized, and any images should include appropriate alternative text.

README.md

@@ -1,9 +1,11 @@
 
-## RStudio Cheatsheets
+## Posit Cheatsheets
 
 <img src="pngs/rstudio-ide.png" width=364 height=288 align="right"/>
 
-The cheatsheets make it easy to learn about and use some of our favorite packages. They are published in their respective PDF versions here: https://www.rstudio.com/resources/cheatsheets/, some are also available in the RStudio IDE under Help > Cheatsheets.
+The cheatsheets make it easy to learn about and use some of our favorite packages. They are published in their respective PDF versions here: https://posit.co/resources/cheatsheets/, some are also available in the RStudio IDE under Help > Cheatsheets.
+
+We are also starting to make some cheatsheets available in a more accessible, text-based HTML format. These are available at https://rstudio.github.io/cheatsheets/.
 
 This repository contains the source files of the current, archived and translated versions.
 
@@ -13,9 +15,16 @@ The cheatsheets use the creative commons copyright. Please see the LICENSE docum
 
 If you wish to contribute to this effort by translating a cheatsheet, please feel free to use the source Keynote file. To submit a translation, please use a Pull Request via GitHub. See the [contributing guidelines](https://github.com/rstudio/cheatsheets/blob/main/.github/CONTRIBUTING.md) for more information.
 
-## Tips for making a new RStudio cheatsheet
+## HTML cheatsheets
+
+If you wish to provide an HTML cheatsheet version, please create a Pull Request 
+with a new `.qmd` file in the `html/` directory of this repository. Use one of 
+the existing `qmd` files there as a starting point/template. These should not be duplicates of the pdf versions - they should be text-based so they are more accessible
+to people with visual impairments. Use of images should be minimized, and any images should include appropriate alternative text.
+
+## Tips for making a new cheatsheet
 
-**RStudio cheatsheets are not meant to be text or documentation!** They are scannable visual aids that use layout and visual mnemonics to help people zoom to the functions they need. Think of cheatsheets as a quick reference, with the emphasis on quick. Here's an analogy:
+**Cheatsheets are not meant to be text or documentation!** They are scannable visual aids that use layout and visual mnemonics to help people zoom to the functions they need. Think of cheatsheets as a quick reference, with the emphasis on quick. Here's an analogy:
 
 > A cheatsheet is more like a well-organized computer menu bar that leads you to a command than like a manual that documents each command.
 
@@ -92,3 +101,15 @@ Budget more time than you expect to make the sheets. So far, I've found this pro
 Your cheatsheet has two goals. First, to help users find essential information quickly, and second, to prevent confusion while doing the above. Your best strategy will be to limit the amount of information you put into the cheatsheet and to lay that information out intuitively and visually. This approach will make your cheatsheet equally useful as a teaching tool, programming tool, or marketing tool.
 
 Cheatsheets fall squarely on the _human-facing side of software design_. They focus on human attention. What does that mean? When you write documentation, your job is to fill in all of the relevant details—that's a software facing job, you need to know the software to do it. You assume that interested humans will find their way to your details on their own (and understand them when they do!). When you make a cheatsheet, your job flips. You assume that the relevant details already exist in the documentation. Your job is to help interested humans find them and understand them.  Your job is to guide the human's attention. Don't just write, design.
+
+## Website
+
+This repo is deployed as a quarto website at https://rstudio.github.io/cheatsheets/.
+It uses [renv](https://rstudio.github.io/renv/) to manage the dependencies to render
+the site (in particular the `html/*.qmd` files that generate the HTML cheatsheets). Packages that are required to render these cheatsheets should be list in `DESCRIPTION`
+so that they are reliably discovered by `renv::snapshot()`.
+
+We prefer the Quarto cheatsheets to set `eval: true` and `output: false` in the
+`execute` options (vs `eval: false`) as this helps to ensure the code in them still works when they are rerun.
+Exceptions can be made on a per-chunk basis, and some (e.g., keras) are not 
+really feasible to run all the time due to complex installation.