Skip to content

docs: update README.md setup order #72

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

Merged
merged 2 commits into from
May 1, 2025
Merged

docs: update README.md setup order #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95a41ff
docs: update README.md setup order
andrewb1269hg May 1, 2025
a53e010
Apply suggestions from code review
andrewb1269hg May 1, 2025
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ The following dependencies are required to run the program:

## 💻 Setup
- Authentication through `gh auth login`
- Set the appropriate token permissions: `gh auth refresh --scopes read:project`
- Note: The team must have `read` permissions on the Project Board in order to view the issues on the board.
- Set the `GITHUB_TOKEN` environment variable: `export GITHUB_TOKEN=$(gh auth token)`
- Set the `GITHUB_UNAME` environment variable: `export GITHUB_UNAME=$(gh auth status | grep "(GITHUB_TOKEN)" | cut -d " " -f9)`
- Set the appropriate token permissions: `gh auth refresh --scopes read:project`
- Note: The team must be a member of the Project Board in order to view the issues on the board.
- Run `make install` inside the repo directory to configure the appropriate versions of dependencies.

## 🛠 Usage
Expand Down