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

fix: Moved _Setting up your environment_ to shared repo. #195

Merged
merged 4 commits into from
Oct 2, 2023
Merged

fix: Moved _Setting up your environment_ to shared repo. #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
67285ea
Add note on giving Feedback to contributing blurb.
stoobie Sep 19, 2023
1a40c49
Added docs-common-content repo to playbook.
stoobie Sep 19, 2023
e8436a9
Moved Environment setup topic to shared repo.
stoobie Sep 19, 2023
24cdd1d
Updated Contributing snippet_contributing_blurb.adoc.
stoobie Sep 19, 2023
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
3 changes: 3 additions & 0 deletions antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ content:
edit_url: 'https://github.com/starknet-edu/starknetbook/edit/main/{path}'
start_paths:
- chapters/book
- url: https://github.com/starknet-io/docs-common-content.git
branches: 'HEAD'
edit_url: 'https://github.com/starknet-io/docs-common-content/edit/main/{path}'

ui:
bundle:
Expand Down
12 changes: 10 additions & 2 deletions chapters/book/modules/ROOT/partials/snippet_contributing_blurb.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
= Contributing

====
The Book is a community-driven effort created for the community.

* If you've learned something, or not, please take a moment to provide feedback through https://a.sprig.com/WTRtdlh2VUlja09lfnNpZDo4MTQyYTlmMy03NzdkLTQ0NDEtOTBiZC01ZjAyNDU0ZDgxMzU=[this 3-question survey].
* 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].
====


[quote, The Starknet Community]
____
*Unleash Your Passion to Perfect StarknetBook*
.Unleash Your Passion to Perfect the Starknet Book

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.
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.

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 changes: 2 additions & 74 deletions chapters/book/modules/chapter_1/pages/environment_setup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,76 +1,4 @@
= Starknet Development Environment Setup
include::1.0.0@docs-common-content:ROOT:partial$partial_environment_setup.adoc[]

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

Essential tools to install:

. link:https://github.com/xJonathanLEI/starkli[Starkli] - A CLI tool for interacting with Starknet. More tools are discussed in Chapter 2.
. 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.

[NOTE]
====
For support or queries, visit our link:https://github.com/starknet-edu/starknetbook/issues[GitHub Issues] or contact espejelomar on Telegram.
====

== Starkli Installation

Easily install Starkli using Starkliup, an installer invoked through the command line.

[source,shell]
----
curl https://get.starkli.sh | sh
starkliup
----

Restart your terminal and confirm installation:

[source,shell]
----
starkli --version
----

To upgrade Starkli, simply repeat the steps.

== Scarb Package Manager Installation

We will get deeper into Scarb in link:https://book.starknet.io/chapter_2/scarb.html[Chapter 2].

For macOS and Linux:

[source,bash]
----
curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
----

For Windows, follow manual setup in the link:https://docs.swmansion.com/scarb/download.html#windows[Scarb documentation].

Restart the terminal and run:

[source,bash]
----
scarb --version
----

To upgrade Scarb, rerun the installation command.

You are now set to code in Cairo and deploy to Starknet!


[NOTE]
====
The Book is a community-driven effort created for the community.

* If you've learned something, or not, please take a moment to provide feedback through https://a.sprig.com/WTRtdlh2VUlja09lfnNpZDo4MTQyYTlmMy03NzdkLTQ0NDEtOTBiZC01ZjAyNDU0ZDgxMzU=[this 3-question survey].
* 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].
====

== Contributing

[quote, The Starknet Community]
____
*Unleash Your Passion to Perfect StarknetBook*

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.

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!
____
Loading