Skip to content

Commit af0d6e1

Browse files
authored
Readme updates 2024 nov (#650)
* Move optional steps for testing VMs out of README.md file This may help avoid new users being confused that they must follow those instructions. Signed-off-by: Andy Fingerhut <[email protected]> * Small updates to top README for P4 dev tool installation options Signed-off-by: Andy Fingerhut <[email protected]> --------- Signed-off-by: Andy Fingerhut <[email protected]> Signed-off-by: Andy Fingerhut <[email protected]>
1 parent b45057e commit af0d6e1

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,28 @@ then we've already provided you with a virtual machine that has all of
8484
the required software installed. Ask an instructor for a USB stick with
8585
the VM image.
8686

87-
Otherwise, to complete the [exercises](https://github.com/p4lang/tutorials/tree/master/exercises), you will need to either build a
88-
virtual machine or install several dependencies.
87+
Otherwise, to complete the
88+
[exercises](https://github.com/p4lang/tutorials/tree/master/exercises),
89+
you will need to do one of the following:
8990

90-
### To build the virtual machine
91+
+ Download and run a virtual machine with the P4 development tools
92+
already installed.
93+
+ Build a virtual machine, compiling and installing the P4 development
94+
tools within it.
95+
+ Install the P4 development tools on an existing system with a
96+
supported version of Ubuntu Linux.
97+
98+
### Download a virtual machine with the P4 development tools already installed
99+
100+
You will need a system with a 64-bit Intel/AMD processor architecture,
101+
with [VirtualBox](https://virtualbox.org) installed on it. See the
102+
table
103+
[here](https://github.com/jafingerhut/p4-guide/blob/master/bin/README-install-troubleshooting.md)
104+
for a list of virtual machine images that you can download, then use
105+
VirtualBox's File->Import Appliance menu item to add the virtual
106+
machine to those on your system.
107+
108+
### To build a virtual machine with the P4 development tools.
91109

92110
#### Requirements
93111

@@ -99,24 +117,21 @@ virtual machine or install several dependencies.
99117

100118
1. Install Vagrant and VirtualBox on your system.
101119
2. Clone the repository
102-
103120
```
104121
git clone https://github.com/p4lang/tutorials.git
105122
```
106123
3. Navigate to the cloned directory :
107-
108124
```
109125
cd vm-ubuntu-24.04
110126
```
111127
4. Start the virtual machine using Vagrant:
112128
```
113129
vagrant up dev
114130
```
115-
*Note* : The time for this step depends on your computer and Internet speed. On a 2015 MacBook Pro with a 50 Mbps download speed, it took approximately 20 minutes. Ensure a stable Internet connection throughout the process.
131+
*Note* : The time for this step depends on your computer and Internet speed. On a 2019 Intel MacBook Pro with a 1 Gbps download speed, it took approximately 2 hours. Ensure a stable Internet connection throughout the process.
116132

117133
### Accessing the VM
118134

119-
120135
- There are two user accounts:
121136
- Username: vagrant | Password: vagrant (This is the default account)
122137
- Username: p4 | Password: p4 (Usage of this account is expected)
@@ -125,10 +140,9 @@ virtual machine or install several dependencies.
125140

126141
You will need the script to execute to completion before you can see the `p4` login on your virtual machine's GUI. In some cases, the `vagrant up` command brings up only the default `vagrant` login with the password `vagrant`. Dependencies may or may not have been installed for you to proceed with running P4 programs. Please refer the [existing issues](https://github.com/p4lang/tutorials/issues) to help fix your problem or create a new one if your specific problem isn't addressed there.
127142

128-
129143
### To install P4 development tools on an existing system
130144

131-
There are instructions and scripts in another Github repository that can, starting from a freshly installed Ubuntu 20.04 or 22.04 Linux system with enough RAM and free disk space, install all of the necessary P4 development tools to run the exercises in this repository. You can find those instructions and scripts [here](https://github.com/jafingerhut/p4-guide/blob/master/bin/README-install-troubleshooting.md) (note that you must clone a copy of that entire repository in order for its install scripts to work).
145+
There are instructions and scripts in another Github repository that can, starting from a freshly installed Ubuntu 20.04, 22.04, or 24.04 Linux system with enough RAM and free disk space, install all of the necessary P4 development tools to run the exercises in this repository. You can find those instructions and scripts [here](https://github.com/jafingerhut/p4-guide/blob/master/bin/README-install-troubleshooting.md) (note that you must clone a copy of that entire repository in order for its install scripts to work).
132146

133147
# How to Contribute
134148

0 commit comments

Comments
 (0)