Skip to content

Commit e82bf44

Browse files
committed
added section for the repository About page
1 parent 9111ce0 commit e82bf44

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ When creating a repository, the preferred method is to create an empty repositor
1919
2020
## Creating a README.md
2121

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.
2323

2424
## License
2525

@@ -115,7 +115,7 @@ The first step is adding doxygen comments to the source code files. This is done
115115

116116
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*).
117117

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:
119119

120120
```bash
121121
cp -R ./docs /path/to/new/repository
@@ -171,3 +171,20 @@ The documentation is built using the GitHub Action located in the ***.github/wor
171171
- Copy this workflow from this How To repository to the new repository
172172
- If desired to build automatically after a check in, un-comment the push event trigger for the workflow.
173173

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

Comments
 (0)