-
-
Notifications
You must be signed in to change notification settings - Fork 55
Track docs #547
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Track docs #547
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9d8d4f8
track docs first draft
TheRealOwenRees d943a0e
spelling error fix
TheRealOwenRees ad65c62
update contributing readme link
TheRealOwenRees 177b75b
update installation to include makefile deps
TheRealOwenRees bd5fc79
change dependencies to minimum required for students
TheRealOwenRees cad9f33
Merge branch 'main' into track-docs
TheRealOwenRees 55b634d
wording changes for installation and VS Code tools
TheRealOwenRees File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -15,25 +15,26 @@ To work on the exercises, you will need these pieces of software: | |||||||||||||||||||||
opam switch | ||||||||||||||||||||||
``` | ||||||||||||||||||||||
|
||||||||||||||||||||||
Switch to that version. If, for example, the latest version is 4.08.0, you will run: | ||||||||||||||||||||||
If you already have a switch for OCaml 5.1, either load that by running `opam switch <switch-name>`, or create a new switch by running: | ||||||||||||||||||||||
|
||||||||||||||||||||||
```bash | ||||||||||||||||||||||
opam switch 4.08.0 | ||||||||||||||||||||||
opam switch create exercism 5.1.1 | ||||||||||||||||||||||
``` | ||||||||||||||||||||||
|
||||||||||||||||||||||
3. Install extended standard libraries and test libraries | ||||||||||||||||||||||
The name `exercism` here is optional, but naming your switches is a good practice. | ||||||||||||||||||||||
|
||||||||||||||||||||||
Some exercises use only the OCaml standard library, and some use the | ||||||||||||||||||||||
extended libraries by Jane Street called Base and Core\_kernel. | ||||||||||||||||||||||
3. Install extended standard libraries and test libraries | ||||||||||||||||||||||
|
||||||||||||||||||||||
The test library is called OUnit, and some exercises additionally use the | ||||||||||||||||||||||
QCheck library for property-based tests. | ||||||||||||||||||||||
Run the script to install the dependencies required by this track: | ||||||||||||||||||||||
|
||||||||||||||||||||||
```bash | ||||||||||||||||||||||
opam install base core_kernel ounit qcheck | ||||||||||||||||||||||
``` | ||||||||||||||||||||||
|
||||||||||||||||||||||
4. Install and use interactive shell | ||||||||||||||||||||||
Some exercises use only the OCaml standard library, and some use the extended libraries by Jane Street called Base and Core_kernel. | ||||||||||||||||||||||
The test library is called OUnit, and some exercises additionally use the QCheck library for property-based tests. | ||||||||||||||||||||||
kahgoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||
|
||||||||||||||||||||||
4. Install and use interactive shell (optional) | ||||||||||||||||||||||
|
||||||||||||||||||||||
A summary of [Setting up and using `utop`](https://dev.realworldocaml.org/install.html): | ||||||||||||||||||||||
|
||||||||||||||||||||||
|
@@ -48,3 +49,9 @@ To work on the exercises, you will need these pieces of software: | |||||||||||||||||||||
#require "base";; | ||||||||||||||||||||||
open Base | ||||||||||||||||||||||
``` | ||||||||||||||||||||||
|
||||||||||||||||||||||
5. Install IDE related tools (optional) | ||||||||||||||||||||||
|
||||||||||||||||||||||
The following relates to using VS Code as your code editor. Adjust accordingly. | ||||||||||||||||||||||
Install the OCaml language server from [here](https://github.com/ocaml/ocaml-lsp). | ||||||||||||||||||||||
Install the OCaml VS Code extension from [here](https://marketplace.visualstudio.com/items?itemName=ocamllabs.ocaml-platform), or search for `OCaml Platform` by Ocaml Labs. | ||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since the items here mainly relate to VS Code, we could mention it in the heading. For example:
Suggested change
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is opam a script? I wasn't really sure ... alternatively, we could leave out the word script like this: