Skip to content

Commit d9eea5b

Browse files
committed
nits in README and INSTALL following #3712
1 parent 20384fd commit d9eea5b

File tree

2 files changed

+20
-32
lines changed

2 files changed

+20
-32
lines changed

INSTALL.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# Installation for Mac OS (Intel / M1 / M2)
1+
# Installation
22

3-
## Basics
3+
Make sure to have enough free disk space for Rust compilation.
4+
5+
Windows users should use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and follow instructions for Linux.
6+
7+
## Installation for Mac OS (Intel / M1 / M2)
8+
9+
### Basics
410

511
* Xcode command line tools
612
- `xcode-select --install`
@@ -15,23 +21,20 @@
1521
* Protoc
1622
- `brew install protobuf`
1723

18-
## Services
19-
20-
* https://aws.amazon.com/cli/
21-
* https://docs.docker.com/desktop/mac/install/
22-
23-
## Additional tooling required by tests
24+
### Additional tooling required by tests
2425

2526
* `brew install jq`
2627
* `cargo install cargo-rdme`
2728
* `cargo install taplo-cli`
2829
* `cargo install cargo-all-features`
2930
* `cargo install cargo-machete`
31+
* https://docs.docker.com/desktop/mac/install/
3032

31-
# Installation for Linux
33+
## Installation for Linux
3234

33-
## Basics
35+
### Basics
3436

37+
* [Git](https://git-scm.com/downloads)
3538
* Rust
3639
- `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
3740
- `rustup target add wasm32-unknown-unknown`
@@ -42,20 +45,16 @@
4245

4346
Alternatively, we have added experimental Nix support (see `flake.nix`).
4447

45-
## Services
46-
47-
* https://aws.amazon.com/cli/
48-
* https://docs.docker.com/engine/install/
49-
50-
## Additional tooling
48+
### Additional tooling required by tests
5149

5250
* `sudo apt-get install jq`
5351
* `cargo install cargo-rdme`
5452
* `cargo install taplo-cli`
5553
* `cargo install cargo-all-features`
5654
* `cargo install cargo-machete`
55+
* https://docs.docker.com/engine/install/
5756

58-
# Installation using Nix
57+
## Installation using Nix
5958

6059
Alternatively, this repository contains a Nix flake that can be used
6160
to prepare a reproducible development environment on Nix-enabled

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,7 @@
1010
<!-- [![Build Status for Kubernetes](https://github.com/linera-io/linera-protocol/actions/workflows/kubernetes.yml/badge.svg)](https://github.com/linera-io/linera-protocol/actions/workflows/kubernetes.yml) -->
1111

1212
[Linera](https://linera.io) is a decentralized blockchain infrastructure designed for highly scalable,
13-
low-latency Web3 applications.
14-
15-
## Key Features
16-
17-
- **High Scalability**: Process thousands of transactions per second with sub-second confirmation times
18-
- **Microchain Architecture**: Each user operates their own chain, eliminating global bottlenecks
19-
- **Low Fees**: Efficient consensus mechanism keeps transaction costs minimal
20-
- **Developer Friendly**: Build applications using familiar Rust and WebAssembly tools
13+
secure, low-latency Web3 applications.
2114

2215
## Documentation
2316

@@ -71,15 +64,11 @@ from low to high levels in the dependency graph)
7164

7265
* [`examples`](./examples) Examples of Linera applications written in Rust.
7366

67+
## Prerequisites
7468

75-
## Quickstart with the Linera CLI tool
69+
See [`INSTALL.md`](./INSTALL.md) for software requirements to develop in this repo.
7670

77-
### Prerequisites
78-
79-
- [Rust](https://www.rust-lang.org/tools/install) (version 1.70 or higher)
80-
- [Git](https://git-scm.com/downloads)
81-
- Approximately 2GB of free disk space
82-
- Linux or macOS (Windows users should use WSL2)
71+
## Quickstart with the Linera CLI tool
8372

8473
The following commands set up a local test network and run some transfers between the
8574
microchains owned by a single wallet.

0 commit comments

Comments
 (0)