Skip to content

Commit 97926b2

Browse files
authored
Merge pull request #21948 from AnnsAnns/file_tree_in_example
doc/guides: Add FileTree to Create Project Guide
2 parents a0cea7e + c6061a2 commit 97926b2

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

doc/guides/c_tutorials/create_project.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ code_folder: examples/guides/creating_project/
55
---
66
import Contact from '@components/contact.astro';
77
import GitSetup from '@components/gitsetup.mdx';
8+
import FileTree from '@components/FileTree.astro';
89

910
Now that we have played around with the examples and have a basic understanding of how to use RIOT,
1011
let's create a new project from scratch.
@@ -96,6 +97,15 @@ include $(RIOTBASE)/Makefile.include
9697

9798
![The Makefile in Visual Studio Code](img/create_project/04_makefile.png)
9899

100+
By now, your project directory should look like this:
101+
102+
<FileTree>
103+
- hello_world
104+
- RIOT/
105+
- **Makefile**
106+
- **main.c**
107+
</FileTree>
108+
99109
Congratulations! You have now created a new project with a simple hello world program.
100110
In the next step, we will build and run our program just like we did in the "Getting Started" guide.
101111

@@ -173,6 +183,16 @@ bin/
173183
*.a
174184
*.out
175185
```
186+
187+
The `.gitignore` should sit in the root of your project directory, like this:
188+
189+
<FileTree>
190+
- hello_world
191+
- RIOT/
192+
- Makefile
193+
- main.c
194+
- **.gitignore**
195+
</FileTree>
176196
:::
177197

178198
## Conclusion

doc/starlight/src/components/gitsetup.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import FileTree from '@components/FileTree.astro';
2+
13
:::note
24
This tutorial assumes that you have already set up your development environment
35
as described in the [Getting Started](/getting-started/installing/) guide.
@@ -50,3 +52,10 @@ Alternatively if you have already cloned your own repository, you can run the fo
5052
git submodule update --init --recursive
5153
```
5254
:::
55+
56+
Your folder should look like this now:
57+
58+
<FileTree>
59+
- hello_world
60+
- **RIOT/**
61+
</FileTree>

0 commit comments

Comments
 (0)