Преглед на файлове

doc: add troubleshooting steps for no build-essentials

KernelDeimos преди 7 месеца
родител
ревизия
1e0b8cfe7c
променени са 2 файла, в които са добавени 55 реда и са изтрити 0 реда
  1. 3 0
      README.md
  2. 52 0
      doc/first-run-issues.md

+ 3 - 0
README.md

@@ -53,6 +53,9 @@ npm start
 
 
 This will launch Puter at http://puter.localhost:4100 (or the next available port).
 This will launch Puter at http://puter.localhost:4100 (or the next available port).
 
 
+If this does not work, see [First Run Issues](./doc/first-run-issues.md) for
+troubleshooting steps.
+
 <br/>
 <br/>
 
 
 ### 🐳 Docker
 ### 🐳 Docker

+ 52 - 0
doc/first-run-issues.md

@@ -0,0 +1,52 @@
+# First Run Issues
+
+## "Cannot find package '@heyputer/backend'"
+
+Scenario: You see the following output:
+
+```
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃  Cannot find package '@heyputer/backend'              ┃
+┃  📝 this usually happens if you forget `npm install`  ┃
+┃  Suggestions:                                         ┃
+┃  - try running `npm install`                          ┃
+┃  Technical Notes:                                     ┃
+┃  - @heyputer/backend is in an npm workspace           ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
+
+1. Ensure you have run `npm install`.
+2. [Install build essentials for your distro](#installing-build-essentials)
+
+## Installing Build Essentials
+
+### Debian-based distros
+
+```
+sudo apt update
+sudo apt install build-essential
+```
+
+### RHEL-family distros (Fedora, Rocky, etc)
+
+```
+sudo dnf groupinstall "Development Tools"
+```
+
+### "I use Arch btw"
+
+```
+sudo pacman -S base-devel
+```
+
+### Alpine
+
+If you're running in Puter's Alpine image then this is already installed.
+
+```
+sudo apk add build-base
+```
+
+### Gentoo
+
+You know what you're doing; you just wanted to see if we mentioned Gentoo.