Skip to content

Commit 46b911e

Browse files
jcfrjcfr
committed
STYLE: Consistently format markdown documents
This commit updates the markdown files based on error reported after updating mirrors-prettier pre-commit hook to run for the "markdown" type in the subsequent commit.
1 parent c47ba08 commit 46b911e

File tree

4 files changed

+42
-53
lines changed

4 files changed

+42
-53
lines changed

‎README.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,19 @@ This will mark the version of the template file used and the Slicer version in t
3535

3636
### Which version of Slicer do the generated application build against ?
3737

38-
Leveraging the ``jinja2-github`` plugin, the ``cookiecutter`` template generator will retrieve the latest commit associated with the Slicer repository default branch and it will set it as ``GIT_TAG`` value in the generated ``CMakeLists.txt``.
39-
40-
38+
Leveraging the `jinja2-github` plugin, the `cookiecutter` template generator will retrieve the latest commit associated with the Slicer repository default branch and it will set it as `GIT_TAG` value in the generated `CMakeLists.txt`.
4139

4240
## License
4341

4442
This project template is distributed under the Apache 2.0 license. Please see
45-
the *LICENSE* file for details.
43+
the _LICENSE_ file for details.
4644

4745
## Authors
4846

49-
* Julien Finet
50-
* Jean-Christophe Fillion-Robin
51-
* Dženan Zukić
52-
* Johan Andruejol
53-
* Alexis Girault
54-
* Cory Quammen
55-
* Jamie Snape
47+
- Julien Finet
48+
- Jean-Christophe Fillion-Robin
49+
- Dženan Zukić
50+
- Johan Andruejol
51+
- Alexis Girault
52+
- Cory Quammen
53+
- Jamie Snape

‎{{cookiecutter.project_name}}/BUILD.md

+13-17
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,25 @@
1-
Build and Package {{cookiecutter.project_name}}
2-
==============================
1+
# Build and Package {{cookiecutter.project_name}}
32

43
This document summarizes how to build and package {{cookiecutter.project_name}} on Windows.
54

65
{{cookiecutter.project_name}} is a custom Slicer application. Reading the [3D Slicer Developer Documentation](https://slicer.readthedocs.io/en/latest/developer_guide/index.html) may help answer additional questions.
76

87
The initial source files were created using [KitwareMedical/SlicerCustomAppTemplate](https://github.com/KitwareMedical/SlicerCustomAppTemplate).
98

10-
Prerequisites
11-
-------------
9+
## Prerequisites
1210

13-
* Setting up your git account:
11+
- Setting up your git account:
1412

15-
* Create a [Github](https://github.com) account.
13+
- Create a [Github](https://github.com) account.
1614

17-
* Setup your SSH keys following [these](https://help.github.com/articles/generating-ssh-keys) instructions.
15+
- Setup your SSH keys following [these](https://help.github.com/articles/generating-ssh-keys) instructions.
1816

19-
* Setup [your git username](https://help.github.com/articles/setting-your-username-in-git) and [your git email](https://help.github.com/articles/setting-your-email-in-git).
17+
- Setup [your git username](https://help.github.com/articles/setting-your-username-in-git) and [your git email](https://help.github.com/articles/setting-your-email-in-git).
2018

21-
* If not already done, email `FirstName LastName <firstname.lastname@{{cookiecutter.github_organization}}.com>` to be granted access to
19+
- If not already done, email `FirstName LastName <firstname.lastname@{{cookiecutter.github_organization}}.com>` to be granted access to
2220
the [{{cookiecutter.github_organization}}/{{cookiecutter.github_project}}](https://github.com/{{cookiecutter.github_organization}}/{{cookiecutter.github_project}}) repository.
2321

24-
Checkout
25-
--------
22+
## Checkout
2623

2724
1. Start `Git Bash`
2825
2. Checkout the source code into a directory `C:\W\` by typing the following commands:
@@ -36,16 +33,16 @@ git clone https://github.com/{{cookiecutter.github_organization}}/{{cookiecutter
3633

3734
Note: use short source and build directory names to avoid the [maximum path length limitation](https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#maximum-path-length-limitation).
3835

39-
Build
40-
-----
36+
## Build
37+
4138
Note: The build process will take approximately 3 hours.
4239

4340
<b>Option 1: CMake GUI and Visual Studio (Recommended)</b>
4441

4542
1. Start [CMake GUI](https://cmake.org/runningcmake/), select source directory `C:\W\{{cookiecutter.github_project|first}}` and set build directory to `C:\W\{{cookiecutter.github_project|first}}R`.
4643
2. Add an entry `Qt5_DIR` pointing to `C:/Qt/${QT_VERSION}/${COMPILER}/lib/cmake/Qt5`.
47-
2. Generate the project.
48-
3. Open `C:\W\{{cookiecutter.github_project|first}}R\{{cookiecutter.project_name}}.sln`, select `Release` and build the project.
44+
3. Generate the project.
45+
4. Open `C:\W\{{cookiecutter.github_project|first}}R\{{cookiecutter.project_name}}.sln`, select `Release` and build the project.
4946

5047
<b>Option 2: Command Line</b>
5148

@@ -60,8 +57,7 @@ cmake -G "Visual Studio 17 2022" -A x64 -DQt5_DIR:PATH=`C:/Qt/${QT_VERSION}/${CO
6057
cmake --build . --config Release -- /maxcpucount:4
6158
```
6259

63-
Package
64-
-------
60+
## Package
6561

6662
Install [NSIS 2](http://sourceforge.net/projects/nsis/files/)
6763

‎{{cookiecutter.project_name}}/CONTRIBUTING.md

+15-17
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
1-
Contributing to {{cookiecutter.project_name}}
2-
===============================
1+
# Contributing to {{cookiecutter.project_name}}
32

43
There are many ways to contribute to {{cookiecutter.project_name}}.
54

6-
* Submit a feature request or bug, or add to the discussion on the [{{cookiecutter.project_name}} issue tracker][is]
7-
* Submit a [Pull Request][pr] to improve {{cookiecutter.project_name}}.
5+
- Submit a feature request or bug, or add to the discussion on the [{{cookiecutter.project_name}} issue tracker][is]
6+
- Submit a [Pull Request][pr] to improve {{cookiecutter.project_name}}.
87

9-
The PR Process, and Related Gotchas
10-
-----------------------------------
8+
## The PR Process, and Related Gotchas
119

12-
#### How to submit a PR ?
10+
### How to submit a PR ?
1311

1412
If you are new to {{cookiecutter.project_name}} development and you don't have push access to the {{cookiecutter.project_name}}
1513
repository, here are the steps:
1614

1715
1. [Fork and clone][fk] the repository.
18-
3. Create a branch.
19-
4. [Push][push] the branch to your GitHub fork.
20-
5. Create a [Pull Request][pr].
16+
2. Create a branch.
17+
3. [Push][push] the branch to your GitHub fork.
18+
4. Create a [Pull Request][pr].
2119

2220
This corresponds to the `Fork & Pull Model` described in the [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)
2321
guides.
@@ -37,17 +35,17 @@ comments posted by the reviewers, you may have to revisit your patches.
3735
Getting your contributions integrated is relatively straightforward, here
3836
is the checklist:
3937

40-
* All tests pass
41-
* Consensus is reached. This usually means that at least one reviewer added a `LGTM` comment
42-
and a reasonable amount of time passed without anyone objecting. `LGTM` is an
43-
acronym for _Looks Good to Me_.
38+
- All tests pass
39+
- Consensus is reached. This usually means that at least one reviewer added a `LGTM` comment
40+
and a reasonable amount of time passed without anyone objecting. `LGTM` is an
41+
acronym for _Looks Good to Me_.
4442

4543
Next, there are two scenarios:
46-
* You do NOT have push access: A {{cookiecutter.project_name}} core developer will integrate your PR.
47-
* You have push access: Simply click on the "Merge pull request" button.
4844

49-
Then, click on the "Delete branch" button that appears afterward.
45+
- You do NOT have push access: A {{cookiecutter.project_name}} core developer will integrate your PR.
46+
- You have push access: Simply click on the "Merge pull request" button.
5047

48+
Then, click on the "Delete branch" button that appears afterward.
5149

5250
[fk]: http://help.github.com/forking/
5351
[push]: https://help.github.com/articles/pushing-to-a-remote/

‎{{cookiecutter.project_name}}/README.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
1-
{{cookiecutter.project_name}} by {{cookiecutter.org_name}}
2-
================================
1+
# {{cookiecutter.project_name}} by {{cookiecutter.org_name}}
32

43
{{cookiecutter.app_description_summary}}
54

65
_This project is in active development and may change from version to version without notice,_
76

87
## Table of contents
98

10-
* [Features](#features)
11-
* [Development](#development)
9+
- [Features](#features)
10+
- [Development](#development)
1211

1312
## Features
1413

1514
_List key features_
1615

17-
1816
## Development
1917

20-
* [Contributing](CONTRIBUTING.md)
21-
* [Building](BUILD.md)
22-
18+
- [Contributing](CONTRIBUTING.md)
19+
- [Building](BUILD.md)
2320

2421
![{{cookiecutter.project_name}} by {{cookiecutter.org_name}}](Applications/{{cookiecutter.app_name}}App/Resources/Images/LogoFull.png?raw=true)

0 commit comments

Comments
 (0)