Skip to content

Commit 79e9595

Browse files
committed
docs: getting started
1 parent c5afa07 commit 79e9595

File tree

5 files changed

+42
-2
lines changed

5 files changed

+42
-2
lines changed

docs/inflator/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@
44
> and is the backbone of efficient goboscript package management.
55
66
This section documents the usage of inflator.
7+
8+
Inflator is written in Python, just like backpack.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Getting started
2+
3+
> This section covers making a project and installing dependencies with inflator
4+
5+
!!! Warning
6+
7+
Before doing anything here, install [goboscript](https://aspizu.github.io/goboscript/), as it is
8+
required for the rest of this tutorial.
9+
10+
It is also recommended to use VSCode with the goboscript editor integration as an IDE of choice.
11+
12+
Let's make a new project with inflator. We'll call it `tutorial`.
13+
14+
Run `inflate new tutorial`. This makes a new project in the directory `tutorial`.
15+
Now open that folder in your IDE.
16+
17+
Here is what mine looks like:
18+
19+
![img.png](img.png)
20+
21+
??? Question "What's the difference between this and [goboscript new?](https://aspizu.github.io/goboscript/getting-started/#create-a-new-project)"
22+
23+
1. Inflator also adds an `inflator.toml` file
24+
2. There is not as much customisation, e.g. disabling the automatic initialisation of a git repository
25+
26+
??? Question "How can I use the behaviour from goboscript new?"
27+
28+
1. Make a project with `goboscript new <args>`
29+
2. Run `inflate toml` within that directory. This will create the inflator.toml file.
30+
31+
Now that we have a goboscript project, check that you can run it using `goboscript build`.
32+
This will generate a sb3 file that you can run in TurboWarp.
33+
34+
If you have TurboWarp bound to the `.sb3` file type, run `start tutorial.sb3` (windows) or `xdg-open tutorial.sb3` (linux).
35+
36+
You should get a 'Hello World' program like this:
37+
38+
![img_1.png](img_1.png)

docs/inflator/usage/img.png

5.56 KB
Loading

docs/inflator/usage/img_1.png

105 KB
Loading

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,5 +126,5 @@ nav:
126126
- Inflator: inflator/index.md
127127
- Installation: inflator/installation.md
128128
- Behaviour: inflator/behaviour.md
129-
- Getting Started:
130-
- Getting Started: inflator/usage/test.md
129+
- Usage:
130+
- Getting Started: inflator/usage/getting started.md

0 commit comments

Comments
 (0)