Skip to content

Commit 33ee669

Browse files
authored
added Devcontainer to building from source
1 parent b0d1d16 commit 33ee669

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

BUILDING_FROM_SOURCE.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
If you run into any problems getting Roc built from source, please ask for help in the `#beginners` channel on [Roc Zulip](https://roc.zulipchat.com) (the fastest way), or create an issue in this repo!
44

5+
## Using Devcontainer
6+
7+
### Codespaces
8+
To access the browser-based editor, you can change the URL of your repository to https://github.dev/roc-lang/roc, replacing github.com with github.dev or go to the roc repo on https://github.com/roc-lang/roc and press . (period key).
9+
10+
Or use it locally in [VSCode](https://code.visualstudio.com/docs/remote/codespaces)
11+
12+
### Docker
13+
14+
Or even run it in your local Docker environment [Developing inside a Container](https://code.visualstudio.com/docs/devcontainers/containers)
15+
516
## Using Nix
617

718
On MacOS and Linux, we highly recommend Using [nix](https://nixos.org/download.html) to quickly install all dependencies necessary to build roc.
@@ -140,7 +151,7 @@ To use the `repl` subcommand, execute `cargo run repl`.
140151

141152
The default is a developer build. For an optimized build, use:
142153

143-
```
154+
```sh
144155
cargo build --release --bin roc
145156
```
146157

devtools/signing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Without a Yubikey:
2828
This explanation was based on the steps outlined [here](https://scatteredcode.net/signing-git-commits-using-yubikey-on-windows/).
2929

3030
On linux, run:
31-
```
31+
```sh
3232
gpg --list-keys --keyid-format SHORT | grep ^pub
3333
gpg --export --armor [Your_Key_ID] > public.asc
3434
```
@@ -46,19 +46,19 @@ Install the [YubiKey Minidriver for 64-bit systems – Windows Installer](https:
4646
Insert your Yubikey and check if it is mentioned in the output of `gpg --card-status` (powershell).
4747

4848
Open powershell and execute:
49-
```
49+
```sh
5050
git config --global gpg.program "c:\Program Files (x86)\GnuPG\bin\gpg.exe"
5151
git config --global commit.gpgsign true
5252
gpg --list-secret-keys --keyid-format LONG
5353
```
5454
The last command will show your keyid. On the line that says `[SC]`, copy the id.
5555
In the example below the id is 683AB68D867FEB5C
56-
```
56+
```sh
5757
sec> rsa4096/683AB68D867FEB5C 2020-02-02 [SC] [expires: 2022-02-02]
5858
```
5959

6060
Tell git your keyid:
61-
```
61+
```sh
6262
>git config --global user.signingkey YOUR_KEY_ID_HERE
6363
```
6464

0 commit comments

Comments
 (0)