From 96ad22cda360f43906efeaafcb4c3ca8f00c88d5 Mon Sep 17 00:00:00 2001 From: mikestefanello <552328+mikestefanello@users.noreply.github.com> Date: Fri, 18 Jul 2025 08:59:09 -0400 Subject: [PATCH] Updated README. --- Makefile | 3 +++ README.md | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 5cb8712..ab97f5e 100644 --- a/Makefile +++ b/Makefile @@ -16,6 +16,9 @@ ifeq ($(OS_SYSNAME),linux) OS_MACHINE = x64 endif +# The appropriate Tailwind package for your OS will attempt to be automatically determined. +# If this is not working, hard-code the package you want using these options: +# https://github.com/tailwindlabs/tailwindcss/releases/latest TAILWIND_PACKAGE = tailwindcss-$(OS_SYSNAME)-$(OS_MACHINE) .PHONY: help diff --git a/README.md b/README.md index dc6a837..5c1ed9d 100644 --- a/README.md +++ b/README.md @@ -183,13 +183,13 @@ cd pagoda Several optional tools are available to make development easier for you. This includes [Ent](#orm) code-generator, for generating ORM code, [Air](https://github.com/air-verse/air) CLI, to provide [live reloading](#live-reloading), and [Tailwind CSS](https://tailwindcss.com/docs/installation/tailwind-cli) CLI, to generate CSS. -If you wish to use Tailwind (with or without [Daisy UI](https://daisyui.com/)), modify the [Makefile](https://github.com/mikestefanello/pagoda/blob/main/Makefile), and adjust the `TAILWIND_PACKAGE` variable to reference the proper package for your operating system. By default, it's set to work with Linux x64. If you want to use Tailwind but don't want to use the standalone CLI, ie `npm`, modify the `tailwind-install` and `css` _make targets_ based on your preferences. +If you don't want to use Tailwind and/or [Daisy UI](https://daisyui.com/), or don't want to use Tailwind's standalone CLI, but rather `npm`, for example, modify the `tailwind-install` and `css` [make targets](https://github.com/mikestefanello/pagoda/blob/main/Makefile) based on your preferences. If the script cannot automatically determine the proper Tailwind package to install, modify the `TAILWIND_PACKAGE` variable to match your operating system. To easily install all tools, run `make install` from the root of the repo. There are also separate _make targets_ for each tool (run `make help` to list all targets). ### Create an admin account -To access the [admin panel](#admin-panel), you must log in with an admin user and to create your first admin user account, you must use the command-line. Execute `make admin email=your@email.com` from the root of the codebase, and an admin account will be generated using that email address. The console will print the randomly-generated password for the account. +To access the [admin panel](#admin-panel), you must log in with an admin user and to create your first admin user account, you must use the command-line. Execute `make admin email=your@email.com` from the root of the codebase, and an admin account will be generated using that email address. The console will print the randomly generated password for the account. Once you have one admin account, you can use that account to manage other users and admins from within the UI.