Merged
Conversation
Specifically, document how to install a local branch of tom_base; and, don't allow the user to source the script (because it contains exit commands that will close their shell).
jchate6
requested changes
Mar 20, 2026
README.md
Outdated
|
|
||
| This is something you would do to work on a TOMToolkit issue, or develop a new feature that you might submit to us as a pull request (PR). Fantastic! Here's how: | ||
|
|
||
| After you've run the `make-tom.sh` script, in your TOM directory: run `pip install -e /path/to/your/local/branch/of/tom_base` |
Contributor
There was a problem hiding this comment.
I think I would change this to:
"After you've run the make-tom.sh script, enter your new TOM's directory and run ..."
I don't want anybody to hastily miss a comma and run make_tom in their existing TOM directory.
github-project-automation
bot
moved this from Needs Review
to Merged (to dev)
in TOM Toolkit
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
UX improvements: docs and saftey
Specifically, document how to install a local branch of tom_base; and, don't allow the user to source the script (because it contains exit commands that will close their shell).
If the tone of the README is too casual, just let me know.
Issues: