From 6d99a6df3132f90d901823e7cb67eac8ad54ace3 Mon Sep 17 00:00:00 2001 From: Albin Ekblom Date: Wed, 14 Jun 2017 04:16:43 +0200 Subject: [PATCH] Cleanup readme (#1934) * Structure readme * Shrink titles --- readme.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index b510ef7f..d5281406 100644 --- a/readme.md +++ b/readme.md @@ -44,7 +44,9 @@ yarn run dist After that, you'll see the binary in the `./dist` folder! -### node-pty issues +#### Known issues that can happen during development + +##### Error building `node-pty` If after building during development you get an alert dialog related to `node-pty` issues, make sure its build process is working correctly by running `yarn run rebuild-node-pty`. @@ -52,7 +54,7 @@ make sure its build process is working correctly by running `yarn run rebuild-no If you're on macOS, this typically is related to Xcode issues (like not having agreed to the Terms of Service by running `sudo xcodebuild` after a fresh Xcode installation). -### Error with `codesign` on macOS when running `yarn run dist` +##### Error with `codesign` on macOS when running `yarn run dist` If you have issues in the `codesign` step when running `yarn run dist` on macOS, you can temporarily disable code signing locally by setting `export CSC_IDENTITY_AUTO_DISCOVERY=false` for the current terminal session.