diff --git a/README.md b/README.md index c511de3e6cd..9cdb8742937 100644 --- a/README.md +++ b/README.md @@ -47,8 +47,8 @@ Before opening an issue, consider using one of the following locations to ensure - [Next milestones](#next-milestones) - [Table of Contents](#table-of-contents) - [Security Issues](#security-issues) +- [Minimal System Requirements](#minimal-system-requirements) - [Install](#install) - - [System Requirements](#system-requirements) - [Docker](#docker) - [Official prebuilt binaries](#official-prebuilt-binaries) - [Updating](#updating) @@ -93,18 +93,13 @@ Before opening an issue, consider using one of the following locations to ensure Please follow [`SECURITY.md`](SECURITY.md). -## Install - -The canonical download instructions for IPFS are over at: https://docs.ipfs.tech/install/. It is **highly recommended** you follow those instructions if you are not interested in working on IPFS development. +### Minimal System Requirements -### System Requirements +IPFS can run on most Linux, macOS, and Windows systems. We recommend running it on a machine with at least 4 GB of RAM and 2 CPU cores (kubo is highly parallel). On systems with less memory, it may not be completely stable, and you run on your own risk. -IPFS can run on most Linux, macOS, and Windows systems. We recommend running it on a machine with at least 2 GB of RAM and 2 CPU cores (kubo is highly parallel). On systems with less memory, it may not be completely stable. - -If your system is resource-constrained, we recommend: +## Install -1. Installing OpenSSL and rebuilding kubo manually with `make build GOTAGS=openssl`. See the [download and compile](#download-and-compile-ipfs) section for more information on compiling kubo. -2. Initializing your daemon with `ipfs init --profile=lowpower` +The canonical download instructions for IPFS are over at: https://docs.ipfs.tech/install/. It is **highly recommended** you follow those instructions if you are not interested in working on IPFS development. ### Docker