Skip to content

Commit 380e609

Browse files
fix(Documentation): Address original PR #1257 review feedback
- Remove redundant 'typical' in getting-started.md development cycle description - Update Windows support from 'Windows 10 only' to 'Windows 10 and later' - Remove proprietary licensing statement from mkdocs.yml copyright line Addresses review comments from @sihyung-maxim on original PR #1257
1 parent 866318d commit 380e609

7 files changed

Lines changed: 3 additions & 4 deletions

File tree

.DS_Store

-6 KB
Binary file not shown.

Documentation/user-guide/getting-started.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Getting Started
2-
3-
The MSDK is designed for both evaluation and end-application development. The typical **evaluation** cycle usually involves setting up the development environment, running demos, and exercising the peripheral driver API on an _evaluation platform_. The typical **development** cycle typically involves building a prototype application on an _evaluation platform_ first, then porting the application to a custom board. This section describes how to get started with the MSDK focusing on the _evaluation_ cycle.
2+
The MSDK is designed for both evaluation and end-application development. The typical **evaluation** cycle usually involves setting up the development environment, running demos, and exercising the peripheral driver API on an _evaluation platform_. The **development** cycle typically involves building a prototype application on an _evaluation platform_ first, then porting the application to a custom board. This section describes how to get started with the MSDK focusing on the _evaluation_ cycle.
43

54
**First**, review the [**Key Concepts**](#key-concepts) below. Then proceed to the section for your preferred IDE. Each subsection is a self-contained quick-start that includes links to additional documentation on important topics.
65

Documentation/user-guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This document describes the MSDK's installation, setup, and usage.
88

99
## Supported Operating Systems
1010

11-
* Windows (Windows 10 only)
11+
* Windows (Windows 10 and later)
1212

1313
* Linux (Ubuntu only)
1414

Examples/.DS_Store

-10 KB
Binary file not shown.

Examples/MAX32680/.DS_Store

-6 KB
Binary file not shown.

Examples/MAX32690/.DS_Store

-8 KB
Binary file not shown.

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: Analog Devices MSDK Documentation
22
site_author: Analog Devices, Inc.
3-
copyright: 'Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved. (now owned by Analog Devices, Inc.), Copyright (C) 2023-2024 Analog Devices, Inc. All Rights Reserved. This software is proprietary to Analog Devices, Inc. and its licensors.'
3+
copyright: 'Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved. (now owned by Analog Devices, Inc.), Copyright (C) 2023-2024 Analog Devices, Inc. All Rights Reserved.'
44
repo_url: https://github.com/analogdevicesinc/msdk
55
docs_dir: 'Documentation'
66
site_dir: 'docs'

0 commit comments

Comments
 (0)