@@ -18,11 +18,12 @@ Project website:
1818- [ Features] ( #features )
1919- [ Supported Platforms] ( #supported-platforms )
2020- [ Getting Started] ( #getting-started )
21- - [ Inside This Repository ] ( #inside-this-repository )
22- - [ Beyond This Repository ] ( #beyond-this-repository )
21+ - [ Project Structure ] ( #project-structure )
22+ - [ Project Website ] ( #project-website )
2323- [ Author] ( #author )
2424- [ License] ( #license )
2525- [ Version] ( #version )
26+ - [ Changelog] ( #changelog )
2627
2728## Features
2829
6566[ Release] ( https://github.com/aafulei/cpp-today/releases ) page, follow the
6667instructions there.
6768
68- - If you built the program yourself using ` make ` , you can run it with
69+ - If you built the program yourself using ` make ` , you can run it with:
6970
7071 ``` shell
7172 make run
@@ -78,15 +79,15 @@ instructions there.
7879 ` ` `
7980
8081You should see the current date printed out in the ` YY/MM/DD = Www` format, for
81- example
82+ example:
8283
8384```
848525/05/14 = Wed
8586```
8687
8788### Install
8889
89- To install the program, run
90+ To install the program, run:
9091
9192```shell
9293make install
@@ -102,21 +103,21 @@ directories of your choice:
102103| ` ./bin/release/today ` | ` /usr/local/bin/ ` |
103104| ` ./docs/man/today.1 ` | ` /usr/local/share/man/man3/ ` |
104105
105- To uninstall the program and the man page, run
106+ To uninstall the program and the man page, run:
106107
107108``` shell
108109make uninstall
109110```
110111
111112### Ask for Help
112113
113- As is typical with command-line programs, run
114+ As is typical with command-line programs, run:
114115
115116``` shell
116117today --help
117118```
118119
119- for help. If the man page has been installed, you can run
120+ for help. If the man page has been installed, you can run:
120121
121122``` shell
122123man today
@@ -127,20 +128,20 @@ to view the manual page for more information.
127128* For detailed user guides, please visit the project website
128129 [ ** aafulei.github.io/cpp-today** ] ( https://aafulei.github.io/cpp-today ) .*
129130
130- ## Inside This Repository
131+ ## Project Structure
131132
132133- [ ` .github/workflows/ ` ] ( ./.github/workflows/ ) — GitHub Actions workflows
133134- [ ` docs/ ` ] ( ./docs/ ) — project documentation files and assets
134135 - [ ` css/ ` ] ( ./docs/css/ ) — custom CSS files for MkDocs and Doxygen
135136 - [ ` img/ ` ] ( ./docs/img/ ) — image files
136- - [ ` man/today.1 ` ] ( ./docs/man/today.1 ) - man page file
137+ - [ ` man/ ` ] ( ./docs/man/ ) - man page files
137138 - [ ` mermaid/ ` ] ( ./docs/mermaid/ ) - source files for Mermaid diagrams
138139 - ` .md ` files - source files for MkDocs to generate the project website
139140- [ ` src/ ` ] ( ./src/ ) — source code
140141- [ ` tests/ ` ] ( ./tests/ ) — test scripts
141142- [ ` .clang-format ` ] ( ./.clang-format ) — Clang Format configuration
142143- [ ` .gitignore ` ] ( ./.gitignore ) — Git ignore patterns
143- - [ ` Changelog .md` ] ( ./Changelog .md ) — changelog
144+ - [ ` CHANGELOG .md` ] ( ./CHANGELOG .md ) — changelog
144145- [ ` Doxyfile ` ] ( ./Doxyfile ) — Doxygen configuration file
145146- [ ` DoxygenLayout.xml ` ] ( ./DoxygenLayout.xml ) — Doxygen website layout
146147- [ ` LICENSE ` ] ( ./LICENSE ) — license file
@@ -150,7 +151,7 @@ to view the manual page for more information.
150151- [ ` compile_flags.txt ` ] ( ./compile_flags.txt ) — Clangd compile options
151152- [ ` mkdocs.yml ` ] ( ./mkdocs.yml ) — MkDocs project website configuration
152153
153- ## Beyond This Repository
154+ ## Project Website
154155
155156![ ] ( ./docs/img/project.png )
156157
175176## Version
176177
1771780.2.0
179+
180+ ## Changelog
181+
182+ For detailed version updates, please see the [ CHANGELOG] ( ./CHANGELOG.md ) .
0 commit comments