You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-2Lines changed: 19 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ When creating a repository, the preferred method is to create an empty repositor
19
19
20
20
## Creating a README.md
21
21
22
-
The ***How To*** Repository (this repository) contains an example README.md file - *README_Example.md*. This provides a easily modified file to build a repository readme around.
22
+
The ***How To*** Repository (this repository) contains an example README.md file - *README_Example.md*. This provides a easily modified file to build a repository README around.
23
23
24
24
## License
25
25
@@ -115,7 +115,7 @@ The first step is adding doxygen comments to the source code files. This is done
115
115
116
116
First copy all the contents of the ./docs directory of this repository to the new repository. This includes the doxygen configuration file, HTML custom additions and a custom css (*doxygen-awesome*).
117
117
118
-
On a unix/macos system this can be done with the following command:
118
+
On a Unix/macos system this can be done with the following command:
119
119
120
120
```bash
121
121
cp -R ./docs /path/to/new/repository
@@ -171,3 +171,20 @@ The documentation is built using the GitHub Action located in the ***.github/wor
171
171
- Copy this workflow from this How To repository to the new repository
172
172
- If desired to build automatically after a check in, un-comment the push event trigger for the workflow.
173
173
174
+
## Setup the Repository About Content
175
+
176
+
On the main code page of the repository, the "About" section (upper right side of the page) contains meta information about the repository and also sets the topics/tags that are used to automatically add the repository to the sparkfun documentation landing page (docs.sparkfun.com).
177
+
178
+
The set About information, select the ***gear*** icon in the section. From here, the following sections are updated
179
+
180
+
### Description
181
+
182
+
Add a detailed, one sentence description for the repository. This is often the same sentence used in the ```libraries.properties``` file.
183
+
184
+
### Website
185
+
186
+
Select the ***Use your GitHub Pages Website*** option for the repository website. NOTE: If the website is not *https* enabled, check your GitHub pages settings for the repository and ensure the *enforce HTTPS* option is checked.
187
+
188
+
### Topics
189
+
190
+
The topics section should be setup to match what is needed for the SparkFun documentation landing page. For the specifics, consult the [documentation landing page readme file](https://github.com/sparkfun/sparkfun.github.io/blob/main/README.md#tags).
0 commit comments