Skip to content

Commit

Permalink
more copy improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
sanity committed Apr 17, 2024
1 parent c3c8295 commit 3f97f70
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions docs/src/tutorial.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,33 @@
# Introduction

This tutorial will show you how to build decentralized software on Freenet. For an example
application please see [apps/freenet-email-app](https://github.com/freenet/freenet-core/tree/main/apps/freenet-email-app).
This tutorial will show you how to build decentralized software on Freenet. For a practical
reference, please see the example application at [apps/freenet-email-app](https://github.com/freenet/freenet-core/tree/main/apps/freenet-email-app).


<!-- toc -->

## Prerequisites

### Rust and Cargo

This will install a Rust development environment including cargo on Linux or a
Mac (for Windows see [here](https://rustup.rs)):
To install a Rust development environment, including Cargo, on Linux or macOS
(for Windows installation, refer to [this guide](https://rustup.rs)), use the
following command:

```bash
curl https://sh.rustup.rs -sSf | sh
```

#### Note for MacOS install

The brew version of Rust will cause problems with `fdev`, we recommend installing Rust
using `rustup` as described above.
Note: The Homebrew installation of Rust may interfere with `fdev`. It is
recommended to use `rustup`, as shown above, to avoid these issues.

### Installing Freenet and fdev

Once you have a working installation of Cargo you can install `freenet` and `fdev`, a
command-line development tool:
After setting up Cargo, install `freenet` and `fdev` with the following command.
This installs `fdev` (the Freenet development tool) and a local Freenet peer
for development purposes:

```bash
cargo install freenet fdev
Expand Down

0 comments on commit 3f97f70

Please sign in to comment.