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

Replace [!NOTE] with less-shouty [!TIP] in READMEs #23

Merged
merged 1 commit into from
Dec 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ gem exec nextgen create myapp

This will download the latest version of the `nextgen` gem and use it to create an app in the `myapp` directory. You'll be asked to configure the tech stack through several interactive prompts. If you have a `~/.railsrc` file, it will be ignored.

> [!NOTE]
> [!TIP]
> If you get an "Unknown command exec" error, fix it by upgrading rubygems: `gem update --system`.

## Examples
Expand All @@ -58,7 +58,7 @@ Check out the [examples directory](./examples) to see some Rails apps that were

On top of that foundation, Nextgen offers dozens of useful enhancements to the vanilla Rails experience. You are free to pick and choose which (if any) of these to apply to your new project. Behind the scenes, **each enhancement is applied in a separate git commit,** so that you can later see what was applied and why, and revert the suggestions if necessary.

> [!NOTE]
> [!TIP]
> For the full list of what Nextgen provides, check out [config/generators.yml](https://github.com/mattbrictson/nextgen/tree/main/config/generators.yml). The source code of each generator can be found in [lib/nextgen/generators](https://github.com/mattbrictson/nextgen/tree/main/lib/nextgen/generators).

Here are some highlights of what Nextgen brings to the table:
Expand Down
2 changes: 1 addition & 1 deletion lib/nextgen/actions.rb
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ def add_lint_task(task, fix: "#{task}:autocorrect")
inject_into_file "README.md", " and lint checks", after: "automated tests"
inject_into_file "README.md", <<~MARKDOWN, after: "```\nbin/rake\n```\n"

> [!NOTE]
> [!TIP]
> Rake allows you to run all checks in parallel with the `-m` option. This is much faster, but since the output is interleaved, it may be harder to read.

```
Expand Down
2 changes: 1 addition & 1 deletion template/README.md.tt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Run this script to install necessary dependencies and prepare the Rails app to b
bin/setup
```

> [!NOTE]
> [!TIP]
> The `bin/setup` script is idempotent and is designed to be run often. You should run it every time you pull code that introduces new dependencies or makes other significant changes to the project.

### Run the app!
Expand Down