The man command, short for manual, displays the setup instructions (what you are reading now) for the courseware. To view the instructions for the current exercise, use the e option. If you are using an IDE, you can also open up the setup instructions (README.md) file or the current exercises instructions (src/test/resources/README.md) file in your workspace.
// display the setup instructions
man [e] > ... > initial-state > man
// display the instructions for the current exercise
man [e] > ... > initial-state > man eAs part of each exercise, we use the run command to bootstrap the main class. This command starts the application for the current exercise that we interact with and verify our solution.
man [e] > ...> initial-state > runNavigation through the courseware is possibile with a few sbt commands. Also, tests are provided to confirm our solution is accurate. It is important to note that the tests make some assumptions about the code, in particular, naming and scope; please adjust your source accordingly. Following are the available navigation commands:
// show the current exercise
man [e] > ... > initial-state > showExerciseId
[INFO] Currently at exercise_000_initial_state
// move to the next exercise
man [e] > ... > ... > nextExercise
[INFO] Moved to ...
// move to the previous exercise
man [e] > ... > ... > prevExercise
[INFO] Moved to exercise_000_initial_state
// save the current state of an exercise for later retrieval and study
man [e] > ... > initial-state > saveState
[INFO] State for exercise exercise_000_initial_state saved successfully
// List previously saved states
man [e] > ... > ... > savedStates
[INFO] Saved exercise states are available for the following exercise(s):
exercise_000_initial_state
...
// Restore a previously saved exercise state
man [e] > ... > initial-state > restoreState exercise_000_initial_state
[INFO] Exercise exercise_000_initial_state restoredTo clean your current exercise, use the clean command from your sbt session. Clean deletes all generated files in the target directory.
man [e] > ... > initial-state > cleanTo compile your current exercise, use the compile command from your sbt session. This command compiles the source in the src/main/scala directory.
man [e] > ... > initial-state > compileTo reload sbt, use the reload command from your sbt session. This command reloads the build definitions, build.sbt, project/.scala and project/.sbt files. Reloading is a requirement if you change the build definition files.
man [e] > ... > initial-state > reloadTo test your current exercise, use the test command from your sbt session. Test compiles and runs all tests for the current exercise. Automated tests are your safeguard and validate whether or not you have completed the exercise successfully and are ready to move on.
man [e] > ... > initial-state > test