Skip to content

Commit

Permalink
Update README.md added copy option in markdown for the python command (
Browse files Browse the repository at this point in the history
…#23)

* Update README.md added copy option in markdown for the python command

* Update README.md regarding checking the environment and cloning the repository
  • Loading branch information
ila-w authored and blakejameson committed Oct 6, 2024
1 parent 01c5e47 commit 93b9343
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,32 @@ F´ (F Prime) flight software for the PROVES CubeSat Kit. This version of the PR
Getting started is easy! Please let us know if you run into any issues with the instructions below.

### Check your environment
You must have Python 3.9+ to build this repo. You can check with `python3 --version`
You must have Python 3.9+ and Git to build this repo. You can check with:
```sh
python3 --version
```
```sh
git --version
```
> **Note**: If you do not have these downloaded to your device, please download [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/).
### Cloning this repository
1. Open your terminal or command prompt

3. Navigate to the location you want to clone the repository to using:
```sh
cd example/path/to/the/repo/location/
```
> **Note**: 'example/path/to/the/repo/location' is a placeholder for the path to the location you wish to put the repo
4. To clone the repository, use the following in your terminal or command prompt:
```sh
git clone https://github.com/proveskit/fprime-proves.git
```
5. Once the repository is finished downloading, navigate into the fprime-proves directory:
```sh
cd fprime-proves/
```

### Setup dependencies

Expand Down

0 comments on commit 93b9343

Please sign in to comment.