You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -31,14 +31,14 @@ Learn more about F' key features [here](https://nasa.github.io/fprime/features.h
31
31
32
32
## Getting Started
33
33
34
-
To get started with F´, install the F´ toolset with:
34
+
To get started with F´, install the F´ bootstrapping tool with:
35
35
```
36
-
pip install fprime-tools
36
+
pip install fprime-bootstrap
37
37
```
38
38
39
39
Then, create a new project with:
40
40
```
41
-
fprime-util new --project
41
+
fprime-bootstrap project
42
42
```
43
43
44
44
See the [HelloWorld Tutorial](https://fprime-community.github.io/fprime-tutorial-hello-world/) to guide you through all the steps of developing an F´ project.
Copy file name to clipboardExpand all lines: docs/INSTALL.md
+25-29Lines changed: 25 additions & 29 deletions
Original file line number
Diff line number
Diff line change
@@ -38,47 +38,45 @@ Requirements:
38
38
> Other OS-specific notes are in the [Troubleshooting](#Troubleshooting) section below.
39
39
40
40
41
+
## Creating a new F´ Project
41
42
42
-
## Setting Up the Development Environment
43
+
The ecosystem of tools supporting F´ is installed as Python packages available via PIP. These packages are installed in a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) by the F´ Bootstrap tool. It is recommended to have one virtual environment per project.
43
44
44
-
The ecosystem of tools supporting F´ is installed as python packages available via PIP. To setup F´ tools, you should create a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/), activate it, and install the latest version of fprime-tools.
45
+
### 1. Install the F´ Bootstrap tool
45
46
46
-
1. Create the virtual environment:
47
-
48
-
```bash
49
-
python3 -m venv fprime-venv
47
+
The F´ Bootstrap tool is responsible for creating a new F´ project and installing the Python dependencies within the project's virtual environment. Install the fprime-bootstrap tool with:
50
48
```
51
-
> You should create a new virtual environment for each new F´ project. The name `fprime-venv` may be changed.
52
-
53
-
2. Activate the virtual environment
54
-
55
-
```bash
56
-
. fprime-venv/bin/activate
49
+
pip install fprime-bootstrap
57
50
```
58
-
> Remember to activate the virtual environment whenever you work with this F´ project.
59
51
60
-
2. Install F´ tools
61
-
```
62
-
pip install -U fprime-tools
63
-
```
64
52
> Some macOS users see an SSL error. [Correct the SSL error](#ssl-error-with-python-37-on-macos) and rerun the above command.
65
53
66
-
##Creating a New Project
54
+
### 2. Create a new project
67
55
68
-
The entrypoint to developing with F´ is creating a new project. This will clone the F´ repository and install the full tool suite of the specified version for working with the selected version of F´.
56
+
The entrypoint to developing with F´ is creating a new project. This will clone the F´ repository and install the full tool suite of the specified version for working with the selected version of F´. To create a new project, run:
69
57
```
70
-
fprime-util new --project
58
+
fprime-bootstrap project
71
59
```
72
60
73
61
This command will ask for some input. Sample responses are below:
74
62
```
75
-
project_name [MyProject]: MyProject
76
-
fprime_branch_or_tag [devel]: devel
77
-
Select install_venv:
78
-
1 - yes
79
-
2 - no
80
-
Choose from 1, 2 [1]: 1
63
+
[1/1] Project name (MyProject): MyProject
64
+
```
65
+
66
+
This commands perform the following actions:
67
+
- Create a new git repository with the standard F´ project structure
68
+
- Create a new virtual environment within the project and install dependencies
69
+
70
+
71
+
### 3. Activate the virtual environment
72
+
73
+
Once the project is created, activate the virtual environment to use the F´ tool suite.
74
+
75
+
```
76
+
cd MyProject
77
+
. fprime-venv/bin/activate
81
78
```
79
+
> Always remember to activate the virtual environment whenever you work with this F´ project.
82
80
83
81
Next steps: [HelloWorld Tutorial](https://fprime-community.github.io/fprime-tutorial-hello-world/)
84
82
@@ -105,9 +103,7 @@ This section will add some known hints to trouble-shooting with the installation
105
103
If the user is using a virtual environment and receives the 'command not found', the problem is likely caused by the environment not being sourced in a new terminal. Make sure to source the environment before running:
106
104
107
105
```
108
-
. /path/to/venv/bin/activate
109
-
e.g.
110
-
. $HOME/fprime-venv/bin/activate
106
+
. <path/to/project>/fprime-venv/bin/activate
111
107
```
112
108
113
109
If installing without a virtual environment, PIP occasionally uses `$HOME/.local/bin` as a place to install user tools. Users running without virtual environments should add this directory to the path.
0 commit comments