Add-badges-to-README.md #8
Merged
Conversation
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
|
@BrickCForce |
… files easier for end users.
Stanrofl
reviewed
Oct 29, 2024
| 1. Copy the `.mise.toml` file from the root of this repo to your project's root and modify it as needed. | ||
| 1. The provided `.devcontainer` will automatically call `mise install` to install the custom versions of the applications. | ||
| 1. After the container is started and you exec into it, `mise` will automatically install the app versions listed in the `.mise.toml` file. | ||
| 1. Other applications can also be installed by editing the `.mise.toml` file. |
There was a problem hiding this comment.
Numbered steps were not incremented here.
There was a problem hiding this comment.
They are not supposed to be. This is Markdown best practice. The downstrem instance automatically numbers them correctly. This makes adding new items in random places and moving items around the list easier.
Stanrofl
reviewed
Oct 29, 2024
README.md
Outdated
| 3. Copy the `.devcontainer` directory to your project. | ||
| 4. Copy the following files to the root of your project. | ||
| These are optional but encouraged. | ||
| - `.mise.toml`: The config file for manageing specific versions of tooling you need for your Go project. |
There was a problem hiding this comment.
Minor type for 'managing'.
Stanrofl
reviewed
Oct 29, 2024
README.md
Outdated
| - [Dev Container Setup](#dev-container-setup) | ||
| - [`dev.sh`](#devsh) | ||
| - [Starship](#starship) | ||
| - [Initial Worksation Setup](#initial-worksation-setup) |
There was a problem hiding this comment.
Typo for 'workstation'? There seems to be 8 instances in total in this file.
Stanrofl
requested changes
Oct 29, 2024
Add instructions as to where the dev container is stored and how to use it.
BrickCForce
approved these changes
Oct 29, 2024
Stanrofl
approved these changes
Oct 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.