From 8a90e3a72b48db9b8de287f6b6e9eb2e00a915cd Mon Sep 17 00:00:00 2001 From: Kevin Burnett <18027+burnettk@users.noreply.github.com> Date: Thu, 12 Oct 2023 05:30:29 -0700 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f8d7dd03..435936f4 100644 --- a/README.md +++ b/README.md @@ -50,11 +50,19 @@ The `docker-compose.yml` file is for running a full-fledged instance of spiff-ar ## Contributing -This is a monorepo based on git subtrees that pulls together various spiffworkflow-related projects. -Feel free to ignore that and drop us a pull request. -If you need to push back from the monorepo to one of the individual repos, here's an example command (and find other scripts we use in the `bin` directory): +To start understanding the system, you might: - git subtree push --prefix=spiffworkflow-frontend git@github.com:sartography/spiffworkflow-frontend.git add_md_file + 1. Explore the demo site via the [Getting Started Guide](https://www.spiffworkflow.org/posts/articles/get_started) + 1. clone this repo, `cd docs`, run `./bin/build`, and open your browser to [http://127.0.0.1:8000](http://127.0.0.1:8000) to view (and ideally edit!) the docs + +Please ignore the `SpiffWorkflow` directory at the root of spiff-arena. +We use https://github.com/sartography/SpiffWorkflow instead. + +## Monorepo + +This is a monorepo based on git subtrees that pulls together various spiffworkflow-related projects. FYI, some scripts: + + ls bin | grep subtree ## License