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

Update readme for better readability #205

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Update readme for better readability #205

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
24 changes: 14 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,26 @@ GitHub UI integration for KS - Kernel Scheduling Method
1. Click on 'Add to Chrome'

## From the Source Code (for development or for external contributors)
1. Go to `chrome://extensions`
1. Make sure you have _Developer Mode_ enabled at the top
1. Click _Load Unpacked Extension_
1. Navigate to the `dist` folder and select it
- Note: Do this after running `npm i` then `npm run web` or `npm run build`

1. Open Source code and then run `npm i` then `npm run web` or `npm run build`
2. Go to `chrome://extensions`
3. Make sure you have _Developer Mode_ enabled at the top
4. Click _Load Unpacked Extension_
5. Navigate to the `dist` folder and select it


# Installing on Firefox
## The "published" version
1. https://stackoverflow.com/c/expensify/questions/7053/7054#7054

## From the Source Code (for development or for external contributors)
1. Open up this page in firefox: `about:debugging#/runtime/this-firefox`
1. Click **Load temporary add-on**
1. Select the `dist/manifest.json` file in this repo (really any file within the dist should work) [more info](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#Trying_it_out)
1. Go to https://github.com/Expensify/App#k2
Note: If this doesn't load you may need to run `npm run build` within the root of the repo to ensure all files have been generated properly (we don't save all of the dist directory to the repo).

1. Open Source code and then run `npm i` then `npm run web` or `npm run build`
2. Open up this page in firefox: `about:debugging#/runtime/this-firefox`
3. Click **Load temporary add-on**
4. Select the `dist/manifest.json` file in this repo (really any file within the dist should work) [more info](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#Trying_it_out)
5. Go to https://github.com/Expensify/App#k2
Note: We don't save all of the dist directory to the repo, so you may need to run `npm run build` within the root of the repo to ensure all files have been generated properly.

## NOTE: It Requires a Personal Access token
Your personal access token is stored locally and securely. It is used to make basic auth calls to the GitHub API. This is so that we don't have to implement OAuth or a separate API and we can get around a lot of the rate limiting issues.
Expand Down
Loading