Skip to content
This repository was archived by the owner on Jun 20, 2024. It is now read-only.

Commit a2d3e28

Browse files
stoobiestoobie
authored
Merge pull request #195 from starknet-edu/steve/share/environment_setup
fix: Moved _Setting up your environment_ to shared repo.
2 parents 311fb6d + 24cdd1d commit a2d3e28

File tree

3 files changed

+15
-76
lines changed

3 files changed

+15
-76
lines changed

‎antora-playbook.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ content:
1111
edit_url: 'https://github.com/starknet-edu/starknetbook/edit/main/{path}'
1212
start_paths:
1313
- chapters/book
14+
- url: https://github.com/starknet-io/docs-common-content.git
15+
branches: 'HEAD'
16+
edit_url: 'https://github.com/starknet-io/docs-common-content/edit/main/{path}'
1417

1518
ui:
1619
bundle:

‎chapters/book/modules/ROOT/partials/snippet_contributing_blurb.adoc‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
= Contributing
22

3+
====
4+
The Book is a community-driven effort created for the community.
5+
6+
* If you've learned something, or not, please take a moment to provide feedback through https://a.sprig.com/WTRtdlh2VUlja09lfnNpZDo4MTQyYTlmMy03NzdkLTQ0NDEtOTBiZC01ZjAyNDU0ZDgxMzU=[this 3-question survey].
7+
* If you discover any errors or have additional suggestions, don't hesitate to open an https://github.com/starknet-edu/starknetbook/issues[issue on our GitHub repository].
8+
====
9+
10+
311
[quote, The Starknet Community]
412
____
5-
*Unleash Your Passion to Perfect StarknetBook*
13+
.Unleash Your Passion to Perfect the Starknet Book
614
7-
StarknetBook is a work in progress, and your passion, expertise, and unique insights can help transform it into something truly exceptional. Don't be afraid to challenge the status quo or break the Book! Together, we can create an invaluable resource that empowers countless others.
15+
The Starknet Book is a work in progress, and your passion, expertise, and unique insights can help transform it into something truly exceptional. Don't be afraid to challenge the status quo or break the Book! Together, we can create an invaluable resource that empowers countless others.
816
917
Embrace the excitement of contributing to something bigger than ourselves. If you see room for improvement, seize the opportunity! Check out our https://github.com/starknet-edu/starknetbook/blob/main/CONTRIBUTING.adoc[guidelines] and join our vibrant community. Let's fearlessly build Starknet!
1018
____

‎chapters/book/modules/chapter_1/pages/environment_setup.adoc‎

Lines changed: 2 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,4 @@
1-
= Starknet Development Environment Setup
1+
include::1.0.0@docs-common-content:ROOT:partial$partial_environment_setup.adoc[]
22

3-
This chapter walks you through setting up your Starknet development tools.
3+
include::ROOT:partial$snippet_contributing_blurb.adoc[]
44

5-
Essential tools to install:
6-
7-
. link:https://github.com/xJonathanLEI/starkli[Starkli] - A CLI tool for interacting with Starknet. More tools are discussed in Chapter 2.
8-
. link:https://github.com/software-mansion/scarb[Scarb] - Cairo's package manager that compiles code to Sierra, a mid-level language between Cairo and CASM.
9-
10-
[NOTE]
11-
====
12-
For support or queries, visit our link:https://github.com/starknet-edu/starknetbook/issues[GitHub Issues] or contact espejelomar on Telegram.
13-
====
14-
15-
== Starkli Installation
16-
17-
Easily install Starkli using Starkliup, an installer invoked through the command line.
18-
19-
[source,shell]
20-
----
21-
curl https://get.starkli.sh | sh
22-
starkliup
23-
----
24-
25-
Restart your terminal and confirm installation:
26-
27-
[source,shell]
28-
----
29-
starkli --version
30-
----
31-
32-
To upgrade Starkli, simply repeat the steps.
33-
34-
== Scarb Package Manager Installation
35-
36-
We will get deeper into Scarb in link:https://book.starknet.io/chapter_2/scarb.html[Chapter 2].
37-
38-
For macOS and Linux:
39-
40-
[source,bash]
41-
----
42-
curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
43-
----
44-
45-
For Windows, follow manual setup in the link:https://docs.swmansion.com/scarb/download.html#windows[Scarb documentation].
46-
47-
Restart the terminal and run:
48-
49-
[source,bash]
50-
----
51-
scarb --version
52-
----
53-
54-
To upgrade Scarb, rerun the installation command.
55-
56-
You are now set to code in Cairo and deploy to Starknet!
57-
58-
59-
[NOTE]
60-
====
61-
The Book is a community-driven effort created for the community.
62-
63-
* If you've learned something, or not, please take a moment to provide feedback through https://a.sprig.com/WTRtdlh2VUlja09lfnNpZDo4MTQyYTlmMy03NzdkLTQ0NDEtOTBiZC01ZjAyNDU0ZDgxMzU=[this 3-question survey].
64-
* If you discover any errors or have additional suggestions, don't hesitate to open an https://github.com/starknet-edu/starknetbook/issues[issue on our GitHub repository].
65-
====
66-
67-
== Contributing
68-
69-
[quote, The Starknet Community]
70-
____
71-
*Unleash Your Passion to Perfect StarknetBook*
72-
73-
StarknetBook is a work in progress, and your passion, expertise, and unique insights can help transform it into something truly exceptional. Don't be afraid to challenge the status quo or break the Book! Together, we can create an invaluable resource that empowers countless others.
74-
75-
Embrace the excitement of contributing to something bigger than ourselves. If you see room for improvement, seize the opportunity! Check out our https://github.com/starknet-edu/starknetbook/blob/main/CONTRIBUTING.adoc[guidelines] and join our vibrant community. Let's fearlessly build Starknet!
76-
____

0 commit comments

Comments
 (0)