From 961b524d86e175c631b7f8ef2b11301e3dfa2643 Mon Sep 17 00:00:00 2001 From: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Date: Thu, 11 Aug 2022 16:25:47 -0400 Subject: [PATCH] feat: better intro Adding more of what I said to people when I led in-person trainings. Which seems like a better way to introduce this whole guide. What is it for? Who is it for? The old landing page said none of that. Now it does. --- src/README.md | 31 +++++++++++++++++++++++-------- src/SUMMARY.md | 1 - src/intro/who-is-this-for.md | 25 ------------------------- 3 files changed, 23 insertions(+), 34 deletions(-) delete mode 100644 src/intro/who-is-this-for.md diff --git a/src/README.md b/src/README.md index 6414fca..0b7b400 100644 --- a/src/README.md +++ b/src/README.md @@ -1,17 +1,32 @@ -# Welcome to RAEN 🌧 +# NEAR + Rust, the friendly way -RAEN is a build tool for NEAR smart contracts. +We couldn't find a good intro to both NEAR and Rust. -With RAEN, you can: +The [Rust Book](https://doc.rust-lang.org/book/) provides a wonderful intro to Rust, the [most-loved programming language](https://en.wikipedia.org/wiki/Rust_(programming_language)#Adoption) seven years running. -* `build`: compile a contract, generate its Application Contract Interface (ACI), and inject it into a custom section of the contract's [WebAssembly](https://webassembly.org/) (Wasm) binary. -* `fetch` _[coming soon]_: use the ACI of a deployed contract to generate source code bindings for cross contract calls and client interfaces. +And some guides, cookbooks, and examples for [NEAR](https://near.org) with Rust are scattered here and there. -NEAR works with any programming language that compiles to Wasm, but the most advanced NEAR SDK and documentation currently exist [for Rust](https://www.near-sdk.io/). +These are useful. These are fine. Especially the Rust Book. We recommend you read it later. -RAEN, too, is built around a [language-agnostic standard](https://github.com/bytecodealliance/wit-bindgen), but currently only works with contracts written in [Rust](https://www.rust-lang.org/). +But none are what we wanted: -This guide will introduce you to NEAR, Rust, and RAEN. +- A quick intro to Rust, providing just enough depth to get you started on your Smart Contract journey; +- A quick explainer of what Smart Contracts even are, and what sorts of problems they solve; +- Examples you can "touch and feel" in the [RAEN Admin](https://raen.dev/admin) panel, so you get a quick feedback loop between modifying Rust code and actually using the resulting smart contract. + +That is, something like [RAEN](https://raen.dev) itself, built to help developers launch NEAR apps faster than they thought possible. + +So this is less a "guide to RAEN" and more a "guide to NEAR + Rust, the RAEN way." + +You'll be ready to get building faster than you think. + +This guide assumes you have experience with the command line and at least one programming language. That's it. + + ### About the name diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 30cc761..9916446 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,7 +1,6 @@ # Summary - [Introduction](README.md) - - [Who is this for?](./intro/who-is-this-for.md) - [Getting Set Up](./intro/getting-set-up.md) - [Counter](./counter/intro.md) - [Defining the data](counter/first_steps.md) diff --git a/src/intro/who-is-this-for.md b/src/intro/who-is-this-for.md deleted file mode 100644 index 1dde493..0000000 --- a/src/intro/who-is-this-for.md +++ /dev/null @@ -1,25 +0,0 @@ -# Who is this for? - -App developers. - -If you're wondering what a blockchain even is or what effects it might have on the world, you can find lots of other introductions. Here's a [booster](https://martinhiesboeck.blog/2018/04/02/how-blockchain-will-save-the-world/), a [doomer](https://www.youtube.com/watch?v=YQ_xWvX1n9g), [some](https://www.youtube.com/watch?v=YQ_xWvX1n9g) [discussions](https://www.nytimes.com/2022/04/05/opinion/ezra-klein-podcast-dan-olson.html), and a [refreshingly neutral intro](https://www.nytimes.com/interactive/2022/03/18/technology/cryptocurrency-crypto-guide.html). - -If you want to know how blockchains work, there's lots of other introductions for that, too. You can learn about [Proof of Work](https://www.3blue1brown.com/lessons/bitcoin) and [Proof of Stake](https://ethereum.org/en/developers/docs/consensus-mechanisms/pos/) and read [lots](https://bitcoinwhitepaper.co/) [of](https://ethereum.org/en/whitepaper/) [whitepapers](https://docs.near.org/docs/concepts/architecture/papers). - -This guide sits in between such philosophical intros and nitty-gritty explainers. - -If you want to learn how to actually _use_ a blockchain, this guide is for you. You'll get a gentle introduction to Rust, the [most-loved language for seven years running](https://insights.stackoverflow.com/survey/2021#technology-most-loved-dreaded-and-wanted), and a gentle introduction to NEAR. - -This guide assumes you have experience with the command line and at least one programming language. That's it. - -If you're already experienced with some other blockchain, you'll be able to go a bit faster through some parts. - -If you already have experience with Rust, you can probably skip certain parts and just look for the NEAR-specific stuff. - -If you're already experienced with Rust and NEAR, you probably don't need to stick around. Just go use RAEN. Have a great time! - -