Skip to content

Commit

Permalink
fix(Documentation): Fix Broken README Links (#909)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jake-Carter authored Feb 6, 2024
1 parent e397bfd commit 9745d84
Showing 1 changed file with 4 additions and 63 deletions.
67 changes: 4 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,35 +39,13 @@ This repo can be cloned using [Git](https://git-scm.com/) to obtain the latest d
* **SSH clone (recommended)**

```bash
git clone --recurse git@github.com:Analog-Devices-MSDK/msdk.git
git clone git@github.com:Analog-Devices-MSDK/msdk.git
```

* **HTTPS Clone**

```bash
git clone --recurse https://github.com/Analog-Devices-MSDK/msdk.git
```

Expected output:

```shell
Cloning into 'msdk'...
remote: Enumerating objects: 65643, done.
remote: Counting objects: 100% (8622/8622), done.
remote: Compressing objects: 100% (4175/4175), done.
remote: Total 65643 (delta 4472), reused 8166 (delta 4215), pack-reused 57021
Receiving objects: 100% (65643/65643), 231.23 MiB | 15.51 MiB/s, done.
Resolving deltas: 100% (48045/48045), done.
Updating files: 100% (20873/20873), done.
Submodule 'Libraries/Cordio' (git@github.com:Analog-Devices-MSDK/Libraries-cordio.git) registered for path 'Libraries/Cordio'
Cloning into '/home/jakecarter/repos/test/msdk/Libraries/Cordio'...
remote: Enumerating objects: 2905, done.
remote: Counting objects: 100% (228/228), done.
remote: Compressing objects: 100% (153/153), done.
remote: Total 2905 (delta 81), reused 193 (delta 70), pack-reused 2677
Receiving objects: 100% (2905/2905), 10.10 MiB | 14.53 MiB/s, done.
Resolving deltas: 100% (1209/1209), done.
Submodule path 'Libraries/Cordio': checked out '91cef69d49e5db8b32602b089007ab1aafe26900'
git clone https://github.com/Analog-Devices-MSDK/msdk.git
```

### Toolchain Setup
Expand Down Expand Up @@ -172,7 +150,7 @@ This repository contains the MSDK's *source code* only. In order to develop on
### Environment Setup (Visual Studio Code)
If you have not previously configured VS Code, see [Setup (VS Code)](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#setup-vs-code_1) in the User Guide.
If you have not previously configured VS Code, see [Setup (VS Code)](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#getting-started-with-visual-studio-code) in the User Guide.
To configure Visual Studio Code for the _development repository_ simply set `MAXIM_PATH` to the cloned location of the _development repo_ instead of the release MSDK in your user settings.json file. After making the change, reload VS Code.
Expand Down Expand Up @@ -247,7 +225,7 @@ This option can be used to configure _all_ Eclipse projects to use the developme
### Environment Setup (Command-Line)
If you have not previously configured the command-line, see [Setup (Command-Line)](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#setup-command-line_1) in the User Guide.
If you have not previously configured the command-line, see [Setup (Command-Line)](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#getting-started-with-command-line-development) in the User Guide.
To configure the command-line for use with the development repo:
Expand All @@ -257,40 +235,3 @@ To configure the command-line for use with the development repo:
- Linux/MacOS: Edit your shell's profile/startup script. Alternatively, edit `setenv.sh` in the root directory of the MSDK and `source` it from the shell's profile/startup script (see [here](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#setup-command-line))
2. Restart your shell
## License Agreement
**© Copyright (C) 2023 Maxim Integrated Products, Inc., All rights Reserved.**
This software is protected by copyright laws of the United States and
of foreign countries. This material may also be protected by patent laws
and technology transfer regulations of the United States and of foreign
countries. This software is furnished under a license agreement and/or a
nondisclosure agreement and may only be used or reproduced in accordance
with the terms of those agreements. Dissemination of this information to
any party or parties not specified in the license agreement and/or
nondisclosure agreement is expressly prohibited.
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.**
Except as contained in this notice, the name of **Maxim Integrated Products, Inc.**
shall not be used except as stated in the **Maxim Integrated Products, Inc. Branding Policy.**
The mere transfer of this software does not imply any licenses
of trade secrets, proprietary technology, copyrights, patents,
trademarks, maskwork rights, or any other form of intellectual
property whatsoever. **Maxim Integrated Products, Inc.** retains all
ownership rights.
[Final Copyright](https://www.maximintegrated.com/en/aboutus/legal/copyrights/default-copyright.html "Final Copyright")
[Final Software License Agreement](https://www.maximintegrated.com/en/aboutus/legal/sla/no-distribute.html "Final SLA")

0 comments on commit 9745d84

Please sign in to comment.