@@ -14,7 +14,9 @@ Unix/Linux). The installation process will create a new Virtual
14
14
Machine (VM) on your computer and the VM will use the Ubuntu GNU/Linux
15
15
operating system.
16
16
17
- *** NOTE:** We only officially support and test development using VirtualBox for AMD and Intel machines and QEMU for M-Series ARM MacOS machines.*
17
+ *** NOTE:** We only officially support and test development using
18
+ VirtualBox for AMD and Intel machines and QEMU for
19
+ M-Series ARM MacOS machines.*
18
20
19
21
---
20
22
@@ -47,16 +49,17 @@ operating system.
47
49
48
50
*** NOTE:** Installing WSL2 may also reconfigure your OS to use Hyper-V or Windows hypervisor
49
51
platform and prevent VirtualBox from working correctly. It is recommended to not install
50
- or use WSL2 alongside Virtualbox for now.*
52
+ or use WSL2 alongside VirtualBox for now.*
51
53
52
- 5 . If you're on M-series ARM MacOS (e.g., M1, M2, M3), you will be using QEMU with SMB file sharing.
54
+ 5 . If you're on an M-series ARM MacOS (e.g., M1, M2, M3),
55
+ you will be using QEMU with SMB file sharing.
53
56
To enable this, open ** System Settings** and navigate to ** General > Sharing** .
54
57
Press the (i) button next to ** File Sharing** , and in the popup window
55
58
click "Options...". Then turn on "Share files and folders using SMB" and
56
59
check the box next to your name in the list below.
57
60
58
61
6 . The complete installation process could take an hour or more and
59
- will quite possibly fail if paused or interrupted. Make
62
+ will probably fail if paused or interrupted. Make
60
63
sure your internet connection is strong and consistent. You'll
61
64
probably want to plug in your laptop power cord. Check your
62
65
computer settings and make sure the machine does not hibernate or
@@ -86,8 +89,9 @@ operating system.
86
89
8 . Locate ** Virtualization** , and enable it.
87
90
(Note: Some motherboards may call it SVM, AMD-V, VT-x/Vanderpool.
88
91
If you cannot find the option to enable virtualization,
89
- [ search Google] ( http://tinyurl.com/enable-virtualization ) for a tutorial on enabling it with your motherboard.)
90
- 9 . Reboot your computer.
92
+ [ search Google] ( http://tinyurl.com/enable-virtualization )
93
+ for a tutorial on enabling it with your motherboard.)
94
+ 9 . Reboot your computer.
91
95
92
96
* ** Windows 11**
93
97
1 . Open ** Change advanced start-up options** by searching for it in the search bar.
@@ -112,15 +116,14 @@ operating system.
112
116
to self-sign the necessary packages to run Vagrant and VirtualBox.
113
117
114
118
2 . DOWNLOAD AND INSTALL THE LATEST DEPENDENCIES
119
+ * Follow the instructions below specific to your host operating system*
115
120
116
- * You will need:
117
- * Follow the instructions below specific to your host operating system*
118
-
121
+ * You will need:
119
122
* [ Ruby] ( https://www.ruby-lang.org/en/downloads )
120
123
* [ Git] ( https://git-scm.com/downloads )
121
- * M-SERIES ARM MacOS: [ QEMU] ( https://www.qemu.org )
122
- * EVERYONE ELSE: [ VirtualBox] ( https://www.virtualbox.org/wiki/Download_Old_Builds_6_1 )
123
124
* [ Vagrant] ( https://www.vagrantup.com )
125
+ * * M-SERIES ARM MacOS:* [ QEMU] ( https://www.qemu.org )
126
+ * * EVERYONE ELSE:* [ VirtualBox] ( https://www.virtualbox.org/wiki/Download_Old_Builds_6_1 )
124
127
125
128
126
129
* ** MacOS**
@@ -162,14 +165,14 @@ operating system.
162
165
163
166
* For Fedora, the latest version of VirtualBox is recommended to
164
167
prevent errors. Download the RPM from the VirtualBox
165
- website. Make sure your version of Fedora is up to date using
168
+ website. Make sure your version of Fedora is up to date using:
166
169
```
167
170
sudo dnf update
168
171
sudo dnf upgrade
169
172
```
170
173
171
- and inputting your password. Then install the Virtual Box rpm
172
- using:
174
+ and then inputting your password when prompted.
175
+ Then install the Virtual Box rpm using:
173
176
```
174
177
sudo dnf install VirtualBox-xxxxx.rpm
175
178
```
@@ -205,7 +208,8 @@ operating system.
205
208
206
209
***NOTE:** If you are not currently part of the Submitty organization on GitHub, you may want to
207
210
[fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
208
- the repo and use the git url from your fork instead, especially if you are looking to contribute.*
211
+ the repo and use the git url from your fork instead, especially if you are looking to
212
+ contribute. You will then make PRs to the main Submitty repository from branches on your fork.*
209
213
210
214
211
215
* **OPTIONAL:** If you will be developing code in one of the companion
@@ -240,7 +244,7 @@ operating system.
240
244
* **Build pre-packaged VM**
241
245
242
246
*NOTE: The pre-packaged Submitty VM is not (yet)
243
- available for qemu / M-Series ARM Mac machines.*
247
+ available for QEMU / M-Series ARM Mac machines.*
244
248
245
249
If you are using VirtualBox as your provider, you will by default
246
250
use a pre-packaged Submitty VM. This will have all of Submitty
@@ -274,36 +278,33 @@ operating system.
274
278
***Note:** The vagrant up command creates and provisions the virtual machine on the first run.
275
279
The `--provider` flag is important if you have more than one provider
276
280
installed on your machine (e.g., VirtualBox, VMWare, QEMU, libvirt).
277
- For subsequent runs, you do not need to append the `--provider` flag as the VM is
281
+ For subsequent runs of `vagrant up` (e.g., to re-start the VM),
282
+ you do not need to append the `--provider` flag as the VM is
278
283
already created.*
279
284
280
285
281
- * **Build (from scratch) using QEMU on an M-Series Arm MacOS**
282
-
283
- If you have an M-series ARM Mac, run:
284
- ```
285
- vagrant up --provider=qemu
286
- ```
287
-
288
- *As noted above, you do not need to append the `--provider` flag on subsequent runs after the VM is already created.*
289
-
290
-
291
286
* **Build from scratch**
292
287
293
- If you wish to run `vagrant up` from scratch, on Linux or Intel-based Mac type:
294
- ```
295
- FROM_SCRATCH=1 vagrant up --virtualbox
296
- ```
288
+ * Using QEMU on an M-Series Arm MacOS, type:
289
+ ```
290
+ vagrant up --provider=qemu
291
+ ```
292
+
293
+ * On Linux or Intel-based Mac, type:
294
+ ```
295
+ FROM_SCRATCH=1 vagrant up --provider=virtualbox
296
+ ```
297
297
298
- Or on Windows with `cmd`, type:
299
- ```
300
- SET FROM_SCRATCH=1
301
- vagrant up --virtualbox
302
- ```
298
+ * Or on Windows with `cmd`, type:
299
+ ```
300
+ SET FROM_SCRATCH=1
301
+ vagrant up --provider= virtualbox
302
+ ```
303
303
304
- *As noted above, you do not need to append the `--provider` flag on subsequent runs after the VM is already created.*
304
+ *As noted above, you do not need to append the `--provider` flag on
305
+ subsequent runs of `vagrant up` after the VM is already created.*
305
306
306
- *This process will take anywhere from 30 minutes to a few hours
307
+ *Building the VM from scratch will take anywhere from 30 minutes to a few hours
307
308
depending on your internet speed.*
308
309
309
310
@@ -324,14 +325,14 @@ operating system.
324
325
creation of these sample submissions and their autograding and
325
326
decrease the time to complete installation.
326
327
327
- * On Linux or Intel-based Mac:
328
+ * On M-series ARM Mac:
328
329
```
329
- NO_SUBMISSIONS=1 FROM_SCRATCH=1 vagrant up --provider=virtualbox
330
+ NO_SUBMISSIONS=1 vagrant up --provider=qemu
330
331
```
331
332
332
- * On M-series ARM Mac:
333
+ * On Linux or Intel-based Mac:
333
334
```
334
- NO_SUBMISSIONS=1 vagrant up --provider=qemu
335
+ NO_SUBMISSIONS=1 FROM_SCRATCH=1 vagrant up --provider=virtualbox
335
336
```
336
337
337
338
* On Windows using `cmd`:
0 commit comments