From 2f6807c2706eaf59074e2c74277eadfa88b248cb Mon Sep 17 00:00:00 2001 From: tommy-mor Date: Mon, 5 Aug 2024 10:24:14 -0700 Subject: [PATCH] beginnigns of tutorial, need help --- Tutorial.scrbl | 9 +++++++++ foundation.scrbl | 1 + tutorial/getting_started.scrbl | 33 +++++++++++++++++++++++++++++++++ 3 files changed, 43 insertions(+) create mode 100644 Tutorial.scrbl create mode 100644 tutorial/getting_started.scrbl diff --git a/Tutorial.scrbl b/Tutorial.scrbl new file mode 100644 index 0000000..f3f981e --- /dev/null +++ b/Tutorial.scrbl @@ -0,0 +1,9 @@ +#lang scribble/manual + +@title[#:style 'toc]{Tutorial} + +Lets say you want to ABE-ify your project. This is how you do that. + +@table-of-contents[] + +@include-section["tutorial/getting_started.scrbl"] diff --git a/foundation.scrbl b/foundation.scrbl index 92f0cfc..f06fab4 100644 --- a/foundation.scrbl +++ b/foundation.scrbl @@ -7,3 +7,4 @@ @include-section["Constitution.scrbl"] @include-section["Attribution_Model.scrbl"] @include-section["Financial_Model.scrbl"] +@include-section["Tutorial.scrbl"] diff --git a/tutorial/getting_started.scrbl b/tutorial/getting_started.scrbl new file mode 100644 index 0000000..d1c639b --- /dev/null +++ b/tutorial/getting_started.scrbl @@ -0,0 +1,33 @@ +#lang scribble/manual + +@title{Getting Started} + +@itemlist[ +#:style 'ordered + +@item{Make a repository @code|{-dia}|, with this structure: + +@;{TODO I wish there was a template repo for this, isntead of having to do it manually.} + +@codeblock|{ +mkdir project-dia +cd project-dia +git init +mkdir evaluation +mkdir input +mkdir pricing +echo "# Dia" > README.md +}| + +} + +@item{Install the @code|{dia}| tool: + +@codeblock|{ +$ raco pkg install "https://github.com/drym-org/dia?path=dia#main" +}| +} + +@;{Not sure what to do next} + +]