@@ -73,7 +73,7 @@ If you using an Intel-based Mac, you will follow the instructions below._
7373## Submitty Developer VM Installation
7474
7575
76- 1 . Enable Virtualization
76+ #### 1. Enable Virtualization
7777
7878 ** MacOS**
7979 1 . Virtualization is generally enabled by default.
@@ -126,16 +126,17 @@ If you using an Intel-based Mac, you will follow the instructions below._
126126 the boot menu/BIOS or follow [ these steps] ( https://era86.github.io/2018/01/24/vagrant-virtualbox-secureboot-in-ubuntu-1604.html )
127127 to self-sign the necessary packages to run Vagrant and VirtualBox.
128128
129- 2 . Download and install the latest version of [ Ruby ] ( https://www.ruby-lang.org/en/downloads ) .
129+ #### 2. Download and install the latest dependencies
130130
131- 3 . Download and install the latest version of [ Git] ( https://git-scm.com/downloads ) .
132-
133- 4 . Download and install [ VirtualBox] ( https://www.virtualbox.org/wiki/Download_Old_Builds_6_1 ) and [ Vagrant] ( https://www.vagrantup.com )
131+ - [ Ruby] ( https://www.ruby-lang.org/en/downloads )
132+ - [ Git] ( https://git-scm.com/downloads )
133+ - [ VirtualBox] ( https://www.virtualbox.org/wiki/Download_Old_Builds_6_1 )
134+ - [ Vagrant] ( https://www.vagrantup.com )
134135
135136 ** Note:**
136137 Please download VirtualBox 6 instead of 7.
137138
138- Below are quick steps to get everything installed and running .
139+ Below are steps specific to an OS .
139140
140141 ** Windows**
141142
@@ -178,7 +179,6 @@ Below are quick steps to get everything installed and running.
178179 ```
179180 sudo dnf install vagrant
180181 ```
181- Now move on to step 5.
182182
183183 **Note:**
184184 When running vagrant up, use `vagrant up --provider=virtualbox` so it doesn't default to libvirt
@@ -196,12 +196,13 @@ Below are quick steps to get everything installed and running.
196196 or if that doesn't work, reboot the computer and then run `vagrant destroy` before re-running `vagrant up --provider=virtualbox` again.
197197
198198
199- 5. Clone [the Submitty repository](https://github.com/Submitty/Submitty) to a location on
200- your computer (the "host").
199+ #### 3. Clone the [Submitty repository](https://github.com/Submitty/Submitty)
201200
202- ```
203- git clone https://github.com/Submitty/Submitty.git
204- ```
201+ Clone it to a location on your computer (the "host").
202+
203+ ```
204+ git clone https://github.com/Submitty/Submitty.git
205+ ```
205206
206207 **Note:** If you are not currently part of the Submitty organization on GitHub, you may want to
207208 [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
@@ -211,50 +212,58 @@ Below are quick steps to get everything installed and running.
211212 Submitty repositories (e.g., AnalysisTools, Lichen, Localization, RainbowGrades, Tutorial), also
212213 clone those repositories to the same directory. For example:_
213214
214- ```
215- home
216- └── myusername
217- └── Submitty
218- └── GIT_CHECKOUT
219- ├── AnalysisTools (optional)
220- ├── Lichen (optional)
221- ├── Localization (optional)
222- ├── RainbowGrades (optional)
223- ├── Submitty
224- └── Tutorial (optional)
225- ```
215+ ```
216+ home
217+ └── myusername
218+ └── Submitty
219+ └── GIT_CHECKOUT
220+ ├── AnalysisTools (optional)
221+ ├── Lichen (optional)
222+ ├── Localization (optional)
223+ ├── RainbowGrades (optional)
224+ ├── Submitty
225+ └── Tutorial (optional)
226+ ```
226227
227- _This host directory structure will be shared / synced between
228- your host operating system and the Submitty virtual machine._
228+ _This host directory structure will be shared / synced between
229+ your host operating system and the Submitty virtual machine._
229230
230- 6. Navigate into the Submitty repository on your computer in a
231- shell/terminal and type:
231+ #### 4. Run Vagrant
232232
233- _Windows should run CMD or powershell on administrator mode_
233+ Navigate into the Submitty repository on your computer in a shell/terminal.
234234
235- ```
236- vagrant up
237- ```
235+ **Build pre-packaged VM**
238236
239237 If you are using VirtualBox as your provider, you will by default use
240238 a pre-packaged Submitty VM. This will have all of Submitty already setup.
241- Vagrant will build your VM for you. This process will take 10 minutes to
239+ Vagrant will build your VM for you.
240+
241+ _On Windows, run CMD or PowerShell on administrator mode_.
242+
243+ ```
244+ vagrant up
245+ ```
246+
247+ This process will take 10 minutes to
242248 maybe half an hour depending on your internet connection speed.
243- When this command finishes, your VM is ready to use.
249+
250+ **Build from scratch**
244251
245252 If you wish to run `vagrant up` from scratch, on Linux or Mac type:
246- ```
247- BASE_BOX=1 vagrant up
248- ```
253+ ```
254+ BASE_BOX=1 vagrant up
255+ ```
249256 or on Windows, type:
250- ```
251- SET BASE_BOX=1
252- vagrant up
253- ```
257+ ```
258+ SET BASE_BOX=1
259+ vagrant up
260+ ```
254261 This process will take anywhere from 30 minutes to a few hours depending on your
255262 internet speed.
256263
257- 7. When the `vagrant up` command completes successfully, you will be
264+ **Build without sample submissions**
265+
266+ When the `vagrant up` command completes successfully, you will be
258267 able to access the Submitty website (instructions follow in the
259268 next section).
260269
@@ -309,7 +318,9 @@ Below are quick steps to get everything installed and running.
309318 ``` pwsh
310319 $Env:NO_SUBMISSIONS
311320 ```
312- 8 . When the installation has completed, you should see the message:
321+ ** Done!**
322+
323+ When the installation has completed, you should see the message:
313324 ```
314325 #####################################################################
315326
0 commit comments