Cleanup readme (#1934)

* Structure readme

* Shrink titles
This commit is contained in:
Albin Ekblom 2017-06-14 04:16:43 +02:00 committed by GitHub
parent debbfa1553
commit 6d99a6df31

View file

@ -44,7 +44,9 @@ yarn run dist
After that, you'll see the binary in the `./dist` folder! 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, 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`. 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 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). 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 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. `export CSC_IDENTITY_AUTO_DISCOVERY=false` for the current terminal session.