pulsar/docs/Building.md

32 lines
1.2 KiB
Markdown
Raw Normal View History

2022-06-20 17:50:54 +03:00
## Building
2022-07-27 07:28:01 +03:00
There are two ways of building and staring hacking on Pulsar's core. One is following the documentation of the flight manual:
2022-06-20 17:50:54 +03:00
* [Linux](https://flight-manual.atom.io/hacking-atom/sections/hacking-on-atom-core/#platform-linux)
* [macOS](https://flight-manual.atom.io/hacking-atom/sections/hacking-on-atom-core/#platform-mac)
2022-07-27 07:28:01 +03:00
* [Windows](https://flight-manual.atom.io/hacking-atom/sections/hacking-on-atom-core/#platform-windows)
### Alternative method
2022-09-03 06:57:34 +03:00
First, install `yarn`. Pulsar currently does not work with `npm` (although it will
2022-07-27 07:28:01 +03:00
probably work in the future). Be sure you're using Node.JS versions between 10 and 16, and
then run:
```shell
yarn install
yarn build
yarn build:apm
```
2022-09-04 09:23:28 +03:00
_If a Windows user it is recommended to install Pulsar on a path with no Spaces_
2022-07-27 07:28:01 +03:00
This will install the packages, rebuild them for Electron, and build the Atom Package
Manager. Finally, you can run the editor with `yarn start`. This command will accept the
same arguments as the final binary.
### Running tests
You can run tests for the editor (both the core editor, or specific packages) the same way
you would run with the final binary: by issuing `yarn --test <path-to-test>`.