From 89a5469151cd21b154f79a8feebce00f5fd9ad56 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Wed, 21 Jan 2015 15:32:37 -0800 Subject: [PATCH] :memo: Mention apm install --check Refs atom/apm#265 --- docs/debugging.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/debugging.md b/docs/debugging.md index 47fcd3fc1..ec202e7f8 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -100,6 +100,21 @@ When an error is thrown in Atom, the developer tools are automatically shown wit If you can reproduce the error, use this approach to get the full stack trace. The stack trace might point to a problem in your [Init script][init script or stylesheet] or a specific package you installed, which you can then disable and report an issue on its GitHub repository. +## Check that you have a build toolchain installed + +If you are having issues installing a package using `apm install`, this could be +because the package has dependencies on libraries that contain native code +and so you will need to have a C++ compiler and Python installed to be able to +install it. + +You can run `apm install --check` to see if [apm][apm] can build native code on +your machine. + +Check out the pre-requisites in the [build instructions][build-instructions] for +your platform for more details. + +[apm]: https://github.com/atom/apm +[build-instructions]: https://github.com/atom/atom/tree/master/docs/build-instructions [submitting issues]: https://github.com/atom/atom/blob/master/CONTRIBUTING.md#submitting-issues [building atom]: https://github.com/atom/atom#building [atom releases]: https://github.com/atom/atom/releases