From f0d3f3d8144518d62846fade43861eb8dc53d413 Mon Sep 17 00:00:00 2001 From: Copple <10214025+kiwicopple@users.noreply.github.com> Date: Fri, 16 Sep 2022 15:34:43 +0200 Subject: [PATCH] Adds init command, adds Readme --- spec/Makefile | 9 +++++++++ spec/README.md | 16 ++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 spec/README.md diff --git a/spec/Makefile b/spec/Makefile index 02dd41fc320..699a3952c37 100644 --- a/spec/Makefile +++ b/spec/Makefile @@ -2,6 +2,15 @@ REPO_DIR=$(shell pwd) run: download transform format + +############################################################################### +# Init - prepare the environment +############################################################################### + +init: + cd $(REPO_DIR)/generator && npm install + + ############################################################################### # Download all the specs ############################################################################### diff --git a/spec/README.md b/spec/README.md new file mode 100644 index 00000000000..d5102c4a96a --- /dev/null +++ b/spec/README.md @@ -0,0 +1,16 @@ +# Supabase Specs + +These spec files are used to generate our documentation. + +## Preparation + +To get started, run `make init`. This will install all dependencies. + +## Usage + +```bash + +make # download latest specs and add enrichments +make.generate # transform the specs into docs + +``` \ No newline at end of file