Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

beginnings of tutorial, need help #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Tutorial.scrbl
Original file line number Diff line number Diff line change
@@ -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"]
1 change: 1 addition & 0 deletions foundation.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
@include-section["Constitution.scrbl"]
@include-section["Attribution_Model.scrbl"]
@include-section["Financial_Model.scrbl"]
@include-section["Tutorial.scrbl"]
33 changes: 33 additions & 0 deletions tutorial/getting_started.scrbl
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#lang scribble/manual

@title{Getting Started}

@itemlist[
#:style 'ordered

@item{Make a repository @code|{<projectname>-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 "# <projectname> 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}

]