mirror of
https://github.com/quine-global/hyper.git
synced 2026-01-12 20:18:41 -09:00
Improve readme (#2196)
* Improve contribute section of readme file In response to issue #2188, the "Contribute" section of readme.md has been improved. The instructions for Linux, Windows, and macOS have been separated to add clarity to the section in question. * Slight change on top of readme commit Change of grammar on one line. * Removal of npm references from readme update
This commit is contained in:
parent
751c06e437
commit
121d411855
1 changed files with 16 additions and 4 deletions
20
readme.md
20
readme.md
|
|
@ -30,10 +30,22 @@ choco install hyper
|
||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
1. Install the dependencies
|
Regardless of the platform you are working on, you will need to have Yarn installed. If you have never installed Yarn before, you can find out how at: https://yarnpkg.com/en/docs/install.
|
||||||
* If you are running Linux, install `icnsutils`, `graphicsmagick`, `xz-utils`, `npm`, `rpm` and `yarn`
|
|
||||||
* If you are running Windows, install `yarn` (If you use the MSI installer you will need to install npm), and `windows-build-tools` with `yarn global add windows-build-tools`.
|
1. Install necessary packages:
|
||||||
* Yarn installation instructions: https://yarnpkg.com/en/docs/install
|
* Windows
|
||||||
|
- Be sure to run `yarn global add windows-build-tools` to install `windows-build-tools`.
|
||||||
|
* macOS
|
||||||
|
- Once you have installed Yarn, you can skip this section!
|
||||||
|
* Linux
|
||||||
|
- RPM-based
|
||||||
|
+ `GraphicsMagick`
|
||||||
|
+ `libicns-utils`
|
||||||
|
+ `xz` (Installed by default on some distributions.)
|
||||||
|
- Debian-based
|
||||||
|
+ `graphicsmagick`
|
||||||
|
+ `icnsutils`
|
||||||
|
+ `xz-utils`
|
||||||
2. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
|
2. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
|
||||||
3. Install the dependencies: `yarn`
|
3. Install the dependencies: `yarn`
|
||||||
4. Build the code and watch for changes: `yarn run dev`
|
4. Build the code and watch for changes: `yarn run dev`
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue