From 215443c495a59f110d054fd7658ccd2306d0a138 Mon Sep 17 00:00:00 2001 From: Rob Brackett Date: Mon, 18 Jun 2018 16:50:58 -0700 Subject: [PATCH] Add system requirements to README, fixes #5136 License: MIT Signed-off-by: Rob Brackett --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index ea5125e126b..34775622c19 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ Please put all issues regarding the Go IPFS _implementation_ in [this repo](http - [Security Issues](#security-issues) - [Install](#install) + - [System Requirements](#system-requirements) - [Install prebuilt packages](#install-prebuilt-packages) - [From Linux package managers](#from-linux-package-managers) - [Build from Source](#build-from-source) @@ -58,6 +59,10 @@ If the issue is a protocol weakness that cannot be immediately exploited or some The canonical download instructions for IPFS are over at: http://ipfs.io/docs/install/. It is **highly suggested** you follow those instructions if you are not interested in working on IPFS development. +### System Requirements + +IPFS can run on most Linux, macOS, and Windows systems. We recommend running it on a machine with at least 2 GB of RAM (it’ll do fine with only one CPU core), but it should run fine with as little as 1 GB of RAM. On systems with less memory, it may not be completely stable. + ### Install prebuilt packages We host prebuilt binaries over at our [distributions page](https://ipfs.io/ipns/dist.ipfs.io#go-ipfs).