Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix broken links in INSTALL.md #2610

Merged
merged 1 commit into from
Mar 25, 2024
Merged

Fix broken links in INSTALL.md #2610

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ This installation guide is specifically designed to enable individuals and resea

**Sections:**
- [System Requirements](#system-requirements)
- [Setting Up the Development Environment](#setting-up-the-development-environment)
- [Creating a New Project](#creating-a-new-project)
- [Creating a New Project](#creating-a-new-f´-project)
- [Working With An Existing Project](#working-with-an-existing-project)
- [Troubleshooting](#troubleshooting)

Expand All @@ -35,7 +34,7 @@ Requirements:

> macOS users must ensure the [CMake command line utility is on their path](#mac-os-x-and-cmake-command-not-found)

> Other OS-specific notes are in the [Troubleshooting](#Troubleshooting) section below.
> Other OS-specific notes are in the [Troubleshooting](#troubleshooting) section below.


## Creating a new F´ Project
Expand All @@ -49,7 +48,7 @@ The F´ Bootstrap tool is responsible for creating a new F´ project and install
pip install fprime-bootstrap
```

> Some macOS users see an SSL error. [Correct the SSL error](#ssl-error-with-python-37-on-macos) and rerun the above command.
> Some macOS users see an SSL error. [Correct the SSL error](#ssl-error-with-python-38-on-macos) and rerun the above command.

### 2. Create a new project

Expand Down Expand Up @@ -84,7 +83,7 @@ Next steps: [HelloWorld Tutorial](https://fprime-community.github.io/fprime-tuto

Sometimes users wish to work with existing F´ projects. Once the project has been acquired, users should install the tools associated with that project. This is done with:

1. Ensure a virtual environment for this project has been created and [activated](#setting-up-the-development-environment)
1. Ensure a virtual environment for this project has been [created and activated](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)

2. Download the project
> When using `git` and submodules, remember to run `git submodule update --init --recursive`
Expand Down
Loading