From c05f7bdf7f693b8813308b38526c276e887d0655 Mon Sep 17 00:00:00 2001 From: Disdain Date: Sun, 27 Oct 2024 16:34:56 -0400 Subject: [PATCH 1/2] Updated README.md Updated the readme file. Removed unwanted getting started section, added node.js to contributing, added suggested vscode extensions. --- README.md | 36 +++++++----------------------------- 1 file changed, 7 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index b09983a..86304c7 100644 --- a/README.md +++ b/README.md @@ -25,37 +25,9 @@ This project leans heavily on these libraries: - [Tailwind CSS](https://tailwindcss.com/) - [Solid UI](https://www.solid-ui.com/) -## Getting Started - -To get started with the project, first install [pnpm](https://pnpm.io) and install dependencies with `pnpm i`. - -## Project Commands - -List of cli commands available from a project root. - -To use the commands, first install [pnpm](https://pnpm.io) and install dependencies with `pnpm i`. - -```bash -pnpm run dev -# Builds all packages in watch mode, and starts all playgrounds -# turbo run dev --parallel - -pnpm run build -# Builds all the packages in the monorepo -# turbo run build --filter=!./playgrounds/* - -pnpm run format -# Formats the repository with prettier -# prettier -w \"packages/**/*.{js,ts,json,css,tsx,jsx,md}\" \"playgrounds/**/*.{js,ts,json,css,tsx,jsx,md}\" - -pnpm run update-deps -# Updates all dependencies in the repository -# pnpm up -Lri -``` - ## Contributing -Giffium is a monorepo managed by [turborepo](https://turborepo.org). The project also requires the use of [pnpm](https://pnpm.io) to manage dependencies. +Giffium is a monorepo managed by [turborepo](https://turborepo.org). The project also requires the use of [pnpm](https://pnpm.io) to manage dependencies and [Node.js](https://nodejs.org) version v22.10.0 ### Getting Started @@ -91,6 +63,12 @@ This will start all the playground in watch mode. The project is built using [SolidJS](https://www.solidjs.com/). If you are new to SolidJS, we recommend checking out their [documentation](https://www.solidjs.com/docs) and [tutorials](https://www.solidjs.com/tutorial). +### Suggested VSCode Extensions + +- Tailwinds +- Headwinds +- Prettier + ## License MIT License From ea7772d17da8daa65cba2205b804bc65a50fa709 Mon Sep 17 00:00:00 2001 From: Disdain Date: Sun, 27 Oct 2024 20:54:02 -0400 Subject: [PATCH 2/2] Removed unwanted sections from the readme.md file and added node.js dependency and suggested vscode extensions --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 86304c7..7e2f947 100644 --- a/README.md +++ b/README.md @@ -65,9 +65,9 @@ The project is built using [SolidJS](https://www.solidjs.com/). If you are new t ### Suggested VSCode Extensions -- Tailwinds -- Headwinds -- Prettier +- [Tailwind CSS IntelliSense](https://tailwindcss.com/) +- [Headwind](https://marketplace.visualstudio.com/items?itemName=heybourn.headwind) +- [Prettier - Code formatter](https://prettier.io/) ## License