commit 876cad8748638a3373ceb963b5f49af620a88d50 parent 1566e4f30fd43bab57056509e62cfdaf4232752f Author: Vincent Forest <vincent.forest@meso-star.com> Date: Mon, 22 Sep 2025 16:29:47 +0200 Add a "Quick Start" section to the README file Diffstat:
| M | README.md | | | 18 | ++++++++++++++++++ |
1 file changed, 18 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -15,6 +15,24 @@ Edit the Makefile configuration as needeed, then run: make clean install +## Quick start + +Assuming star-ty has been installed under `/usr/local` +(default behavior): + + cp -r /usr/local/share/star-ty/ my_web_site + cd my_web_site + make + +Check scripts and generated content: + + make lint + +Deploy the files locally and allow members of the "users" group to +update them: + + make PREFIX="${TMPFILE:-/tmp}"/local GROUP=users install + ## License Copyright © 2017-2025 |Méso|Star> (contact@meso-star.com)