Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve grammar in README.md #225

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve grammar in README.md #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
# SideQuest
Below is the documentation of SideQuest with instructions for building and signing then application.
Below is the documentation of SideQuest with instructions for building and signing the application.

### Build Steps

Clone the repo

To install the app dependencies
To install the app's dependencies, run:
```
yarn install
```

To start the dev stack run
To start the dev stack, run:
```
yarn start
```

To build the angular app only
To build the angular app only, run:
```
yarn app-build
```


To build the electron app only
To build the electron app only, run:
```
yarn build
yarn build --mac
yarn build --wlm
```

To build the app & angular app (NOT for Raspberry Pi)
To build the app & angular app (NOT for Raspberry Pi), run:
```
yarn dist
```

To build the app & angular app on a Raspberry Pi
To build the app & angular app on a Raspberry Pi, run:
```
yarn dist --armv7l
```

To re-launch electron if you accidentally close it
To re-launch electron if you accidentally close it, run:
```
yarn electron
```

To reset things
To reset things, run:
```
yarn reset
```
Expand Down Expand Up @@ -77,6 +77,6 @@ WIN_CSC_LINK - The base64 encoded .p12 file ( Windows Code Signing Cert ). as a

WIN_CSC_KEY_PASSWORD - The passphrase used when generating the .p12 file for windows.

Edit: Windows signing no longer works without a usb dongle because fuck the signing industry.
Edit: Windows signing no longer works without a USB dongle because fuck the signing industry.

You'll need this on the path to build for windows locally: C:\Users\USER\AppData\Local\electron-builder\Cache\winCodeSign\winCodeSign-2.6.0\windows-10\x64