Add system requirements to README, fixes #5136
License: MIT Signed-off-by: Rob Brackett <rob@robbrackett.com>
Rob Brackett committed
Jun 18, 2018 at 16:50 UTC
215443c495a59f110d054fd7658ccd2306d0a138
1 file changed
+5
README.md
+5
@@ -28,6 +28,7 @@ Please put all issues regarding the Go IPFS _implementation_ in [this repo](http
28
29
- [Security Issues](#security-issues)
30
- [Install](#install)
31
+ - [System Requirements](#system-requirements)
32
- [Install prebuilt packages](#install-prebuilt-packages)
33
- [From Linux package managers](#from-linux-package-managers)
34
- [Build from Source](#build-from-source)
@@ -58,6 +59,10 @@ If the issue is a protocol weakness that cannot be immediately exploited or some
59
60
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.
61
62
+### System Requirements
63
+
64
+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.
65
+
66
### Install prebuilt packages
67
68
We host prebuilt binaries over at our [distributions page](https://ipfs.io/ipns/dist.ipfs.io#go-ipfs).