Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
codytodonnell committed Dec 9, 2023
1 parent bc3c6b0 commit 08ba7fe
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
<img width="500" alt="strudel-logo-cropped" src="https://github.com/lbl-ux/strudel/assets/420923/87cb4bd1-8c8d-4dfb-924f-f96f84017f2d">

[Website (under construction!)](https://strudel.science/strudel-web)
The Scientific sofTware Research for User experience, Design, Engagement, and Learning project (STRUDEL) is a planning framework and design system that empowers people to build effective user interfaces for scientific software.

# Scientific sofTware Research for User experience, Design, Engagement, and Learning (STRUDEL)
# strudel-web

The Scientific sofTware Research for User experience, Design, Engagement, and Learning project (STRUDEL) will develop a typology and design system for scientific software towards improving the usability and user interfaces.
**strudel-web** contains the code and content for the public-facing STRUDEL website. The code in this repo is deployed as the STRUDEL staging website. When ready for production, the Deploy Production Site GitHub action copies the code over to the [strudel-web-prod](https://github.com/strudel-science/strudel-science.github.io) repo and deploys it to the production site.

The STRUDEL project is based at Lawrence Berkeley National Laboratory. The team members are:
* Lavanya Ramakrishnan (PI)
* Rajshree Deshmukh
* Dan Gunter
* Drew Paine
* Sarah Poon
* Cody O'Donnell
- [Staging Website](https://strudel.science/strudel-web)
- [Production Website](https://strudel.science/)

## Content Contributor Guide

There are two ways that content gets loaded into the website:
1. Markdown (.mdx) files in the `content` directory
2. React page components in the `src/pages` directory

## Developer Guide

## 🚀 Quick start
This website is built with [Gatsby](https://www.gatsbyjs.com/docs), a React-based framework for building websites.

1. **Clone the repo and install dependencies**

Expand Down Expand Up @@ -52,4 +55,17 @@ The STRUDEL project is based at Lawrence Berkeley National Laboratory. The team
- [Guides](https://www.gatsbyjs.com/docs/how-to/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
- [API Reference](https://www.gatsbyjs.com/docs/api-reference/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
- [Plugin Library](https://www.gatsbyjs.com/plugins?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
- [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
- [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)

# About STRUDEL
## Scientific sofTware Research for User experience, Design, Engagement, and Learning

The Scientific sofTware Research for User experience, Design, Engagement, and Learning project (STRUDEL) is a planning framework and design system for scientific software towards improving the usability and user interfaces.

The STRUDEL project is based at Lawrence Berkeley National Laboratory. The team members are:
* Lavanya Ramakrishnan (PI)
* Rajshree Deshmukh
* Dan Gunter
* Drew Paine
* Sarah Poon
* Cody O'Donnell

0 comments on commit 08ba7fe

Please sign in to comment.