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.

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.md #26

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

Update README.md #26

wants to merge 1 commit into from

Conversation

Sebastian-ubs
Copy link
Contributor

@Sebastian-ubs Sebastian-ubs commented Jul 3, 2024

add details on how to run Platform.Bible with extensions


This change is Reviewable

add details on how to run Platform.Bible with extensions
Copy link
Member

@tjcouch-sil tjcouch-sil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm: thanks for the update! As you mentioned, I would recommend making these changes in both templates as well. It's fine to get this change in now, though, if you want to go ahead and get it in. As long as you make exactly the same changes in the templates, there won't be a problem merging updates from the templates. So either way is probably fine.

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @Sebastian-ubs)

Copy link
Member

@tjcouch-sil tjcouch-sil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @Sebastian-ubs)


README.md line 66 at r1 (raw file):

`npm start`

Note: The built extensions will be the `dist` folder. In order for Platform.Bible to run these extensions, you must provide the directory to these built extensions to Platform.Bible via a command-line argument. This command-line argument is already provided in this `package.json`'s `start` script. If you want to start Platform.Bible and use these extensions any other way, you must provide this command-line argument (e.g. `Platform.Bible.exe --extensions ./dist`) or put the `dist` folder into Platform.Bible's [extensions folder](https://github.com/paranext/paranext-core/blob/edce560ccb0de06b6e98707bfb1879b359194ea2/src/extension-host/services/extension.service.ts#L162).

Oh actually, as we noticed, this should actually be --extensionDirs

@Sebastian-ubs
Copy link
Contributor Author

Please help me understand. Are the 2 templates

@tjcouch-sil
Copy link
Member

Please help me understand. Are the 2 templates

Yep, those are the two readmes! They are manually synced. Maybe there is a way to improve it, but we haven't thought of something yet. Matt and I are actually planning to discuss this kind of duplication stuff pretty soon. Definitely interested to hear if you have ideas!

tjcouch-sil pushed a commit that referenced this pull request Oct 21, 2024
- `npm audit fix`
- also ran `npx update-browserslist-db@latest`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants