Skip to content

Commit 850b4c1

Browse files
updating documentation
Signed-off-by: Kent Madsen <kent.vejrup.madsen@designermadsen.dk>
1 parent 86ff3ef commit 850b4c1

1 file changed

Lines changed: 28 additions & 18 deletions

File tree

Readme.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Hardware Performance Archive
2-
![Repository cover image for social networks][CoverImage]
2+
![Repository cover image for social networks][Cover_Image]
33

44
This repository contains data that are recorded hardware performance. The raw data is saved in CSV[^7]
55
fileformat and is located in the dataset directory.
66

77
The release of the latest version can be found and downloaded at
8-
[Kaggle](https://www.kaggle.com/datasets/kentvejrupmadsen/dataset-performance).
8+
[Kaggle][KAGGLE_DATASET_LOCATION].
99
You're welcome to experiement with it in 'notebooks' and etc.
1010

1111

1212
## Overview
13-
* Go to content description At [this location](docs/contents.md).
13+
* Go to content description At [this location][CONTENT_LOCATION].
1414
* Current Version at: V1.0.6
1515
* Size of dataset directory: 16.7 GB
1616
* Dataset
@@ -35,8 +35,8 @@ You're welcome to experiement with it in 'notebooks' and etc.
3535

3636
### Tools
3737
* Files logged with
38-
[OpenHardwareMonitor it can be downloaded here](https://openhardwaremonitor.org/downloads/),
39-
it's repository is at: [on github](https://github.com/openhardwaremonitor/openhardwaremonitor)
38+
[OpenHardwareMonitor it can be downloaded here][DOWNLOAD_OPENHARDWARE_MONITOR],
39+
it's repository is at: [on github][OPENHARDWARE_MONITOR_GITHUB]
4040

4141

4242

@@ -58,9 +58,9 @@ Currently in development
5858
Currently also working on having the data sorted & filtered by Year. together with making branches for it.
5959

6060
### Download & Others
61-
* [Kaggle](https://www.kaggle.com/datasets/kentvejrupmadsen/dataset-performance)
61+
* [Kaggle][KAGGLE_DATASET_LOCATION]
6262
a place to download datasets and to play with data. Which can be though a python terminal or their website.
63-
* [Web Archive](https://archive.org/download/data.private.performance-release-06-09-2022)
63+
* [Web Archive][WEBARCHIVE_DATASET_LOCATION]
6464

6565
* Onedrive
6666
* [Zip](https://1drv.ms/u/s!AnVSo6qhoQp5j8RjDo0Z3ozNKr9xXQ?e=H3qbAm)[^2],
@@ -73,15 +73,14 @@ a place to download datasets and to play with data. Which can be though a python
7373

7474
## Appendices
7575
* Keep in mind that this repository is a fork of the repository [Private-Data-Performance][OLD_REPOSITORY],
76-
at my previous [account][PREVIOUS_ACCOUNT]
77-
as i have lost access to it.
78-
* Author - [Kent vejrup Madsen](https://github.com/KentVejrupMadsen)
76+
at my previous [account][PREVIOUS_ACCOUNT] as i have lost access to it.
77+
* Author: [Kent vejrup Madsen][CURRENT_ACCOUNT]
7978
* Contact: Kent.vejrup.madsen@designermadsen.dk
80-
* Changelog: [Changes](docs/changelog.md)
81-
* Copyright 2024 [Kent vejrup Madsen](https://github.com/KentVejrupMadsen)
79+
* Changelog: [Changes][CHANGELOG_LOCATION]
80+
* Copyright 2024 [Kent vejrup Madsen][CURRENT_ACCOUNT]
8281
* Licenses
83-
* [MIT - Source Code License][MITLicense]
84-
* [Dataset License - Attribution 4.0 International][ATT4INTLicense]
82+
* [MIT - Source Code License][MIT_License]
83+
* [Dataset License - Attribution 4.0 International][ATT4INT_License]
8584

8685

8786

@@ -128,10 +127,21 @@ as i have lost access to it.
128127
[^7]: Comma-seperated values
129128

130129
<!-- Shortcuts -->
131-
[CoverImage]:docs/resources/3.jpg
130+
[Cover_Image]:docs/resources/3.jpg
132131

133-
[MITLicense]:sourcecode_license.md
134-
[ATT4INTLicense]:License.md
132+
[MIT_License]:sourcecode_license.md
133+
[ATT4INT_License]:License.md
135134

136135
[OLD_REPOSITORY]:https://github.com/KentMadsen/Private-Data-Performance
137-
[PREVIOUS_ACCOUNT]:https://github.com/KentMadsen
136+
137+
[KAGGLE_DATASET_LOCATION]: https://www.kaggle.com/datasets/kentvejrupmadsen/dataset-performance
138+
[WEBARCHIVE_DATASET_LOCATION]: https://archive.org/download/data.private.performance-release-06-09-2022
139+
140+
[PREVIOUS_ACCOUNT]:https://github.com/KentMadsen
141+
[CURRENT_ACCOUNT]:https://github.com/KentVejrupMadsen
142+
143+
[CHANGELOG_LOCATION]:docs/changelog.md
144+
[CONTENT_LOCATION]:docs/contents.md
145+
146+
[DOWNLOAD_OPENHARDWARE_MONITOR]:https://openhardwaremonitor.org/downloads/
147+
[OPENHARDWARE_MONITOR_GITHUB]:https://github.com/openhardwaremonitor/openhardwaremonitor

0 commit comments

Comments
 (0)