@cryptotaxi247 / kubo / commits / 0c57a4f62

docs(readme): minimal reqs (#10066)

Marcin Rataj committed Aug 14, 2023 at 15:45 UTC 0c57a4f6229b73ecd69d7a3354aa33367aa1d201
1 file changed +5 -10
README.md
+5 -10
@@ -47,8 +47,8 @@ Before opening an issue, consider using one of the following locations to ensure
47 - [Next milestones](#next-milestones)
48 - [Table of Contents](#table-of-contents)
49 - [Security Issues](#security-issues)
50 +- [Minimal System Requirements](#minimal-system-requirements)
51 - [Install](#install)
51 - - [System Requirements](#system-requirements)
52 - [Docker](#docker)
53 - [Official prebuilt binaries](#official-prebuilt-binaries)
54 - [Updating](#updating)
@@ -93,18 +93,13 @@ Before opening an issue, consider using one of the following locations to ensure
93
94 Please follow [`SECURITY.md`](SECURITY.md).
95
96 -## Install
97 -
98 -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.
96 +### Minimal System Requirements
97
100 -### System Requirements
98 +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.
99
102 -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.
103 -
104 -If your system is resource-constrained, we recommend:
100 +## Install
101
106 -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.
107 -2. Initializing your daemon with `ipfs init --profile=lowpower`
102 +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.
103
104 ### Docker
105