-
-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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 and Taskfile.yml for easier new-dev setup #1117
Open
rmunn
wants to merge
2
commits into
develop
Choose a base branch
from
chore/readme-updates
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,10 +30,23 @@ Other files, like `skaffold.yaml`, should be at the root of the repo, because th | |
* mac: `brew install go-task/tap/go-task` | ||
* via npm: `npm install -g @go-task/cli` | ||
* install [Skaffold](https://skaffold.dev/docs/install/#standalone-binary) and add it to your path | ||
* the file you will download is **NOT** an installer, just a standalone runnable .exe (on Windows) or binary (on Linux) | ||
* on Linux, a good practice is to create `$HOME/.local/bin` and put binaries there; most distributions automatically add `$HOME/.local/bin` to your path if it exists | ||
* don't forget to run `chmod +x $HOME/.local/bin/skaffold` | ||
* on Windows, we suggest creating a `bin` folder in your home folder. Put the Skaffold binary there, then do the following: | ||
* go to your System properties, click the **Advanced** tab, and click **Environment Variables...** | ||
* Click the Path variable (in either User or System, User is recommended) and click the **Edit...** button | ||
* Add `C:\Users\YOUR_USER_NAME\bin` to the list and click **OK** | ||
* clone the repo | ||
* run setup `task setup`, which: | ||
* run `git push` to make sure your GitHub credentials are set up | ||
* on Windows, allow the Git Credential Manager to log in to GitHub via your browser | ||
* on Linux, upload your SSH key to your GitHub account if you haven't done so already, then run `git remote set-url --push origin [email protected]:sillsdev/languageforge-lexbox` | ||
* on Windows, open PowerShell and run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned` | ||
* this is necessary before running `task setup` below, which uses a PowerShell script to download seed data | ||
* run `task setup`, which: | ||
* initializes a local.env file | ||
* tells Git to use our ignore revs file | ||
* checks out Git submodules | ||
* downloads the FLEx repo for the project seed data | ||
|
||
#### Extra setup steps for Windows | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this would be a valuable addition: