mirror of
https://github.com/Wessel/boilerplate.git
synced 2026-07-26 18:21:31 +02:00
feat: refresh boilerplate
This commit is contained in:
38
README.md
38
README.md
@@ -1,14 +1,40 @@
|
||||
<img src="$(LOGO_SQUARE).svg" align="left" width="192px" height="192px"/>
|
||||
<!---
|
||||
To update:
|
||||
project.
|
||||
master - The master org or user of the repo
|
||||
linter - The linter used for the project
|
||||
name - Project name
|
||||
lang - The (primary) programming language used
|
||||
logo - Project logo
|
||||
contact - All ways to contact for any inqueries
|
||||
reviewers - A list of users to auto-assign to issues and features
|
||||
info.
|
||||
toc - Table of Contents of README
|
||||
desc - Small project description
|
||||
badges - Any extra badges
|
||||
setup.
|
||||
prerequisites - The prerequisites needed to run the project
|
||||
install - Command for initial installation
|
||||
test - Command for running tests
|
||||
tree.
|
||||
parts - All individual parts of the project
|
||||
--->
|
||||
<img src="{{project.logo}}" align="left" width="192px" height="192px"/>
|
||||
<img align="left" width="0" height="192px" hspace="10"/>
|
||||
|
||||
> $(PROJECT_NAME)
|
||||
> {{project.name}}
|
||||
|
||||
[](/LICENSE) $(BADGES)
|
||||
[](/LICENSE) {{info.badges}}
|
||||
|
||||
$(SMALL_DESC)
|
||||
{{info.desc}}
|
||||
|
||||
<br>
|
||||
|
||||
<!---
|
||||
Example table of contents:
|
||||
* header
|
||||
* sub header
|
||||
--->
|
||||
## Table of contents
|
||||
* $(HEADER)
|
||||
* $(SUB_HEADER)
|
||||
{{info.toc}}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user