Commit Graph

133 Commits

Author SHA1 Message Date
Anton-4
66ff807eff
better nix install instructions 2024-01-31 14:01:22 +01:00
Brendan Hansknecht
fc09c3b002
remove debugir 2023-12-04 13:50:53 -08:00
Stefan van der Walt
6a2ac5ac93 Clarify what to do with zig binary 2023-11-22 14:22:39 -08:00
Stefan van der Walt
6883c76935 Add prefix as suggested by @rtfeldman 2023-11-22 14:21:12 -08:00
Stefan van der Walt
7ae83b59d5 Clean up zig section 2023-11-22 14:21:12 -08:00
Stefan van der Walt
c1af12600f Re-organize the LLVM build instructions
- `zig` needs `lib` directory
- `llvm` needs development headers
- Keep installation instructions together
- Group by platform
- No longer split installation and debugging instructions
2023-11-22 14:21:12 -08:00
Anton-4
254180ebfe
remove libxkb-common requirement
This is only necessary for running GUI examples

Signed-off-by: Anton-4 <17049058+Anton-4@users.noreply.github.com>
2023-11-22 11:45:31 +01:00
Brendan Hansknecht
077672b058
update llvm and zig version in all locations 2023-10-23 13:50:32 -07:00
Anton-4
99cfd1fe92
removed editor, ast, markup crate 2023-09-11 16:40:52 +02:00
Kevin Gillette
0321f91c70
Kevin Gillette: markdown typo fixes
Luke Boswell: move Str.md as it looks more like a design doc than rust crate

Co-authored-by: Luke Boswell <lukewilliamboswell@gmail.com>
2023-04-10 14:07:03 -06:00
Anton-4
5d7a50dedd
remove mention linux aarch64
Signed-off-by: Anton-4 <17049058+Anton-4@users.noreply.github.com>
2023-01-07 13:37:59 +01:00
Folkert
12aca5eb11
remove cargo bindgen as a dependency
we needed this for wasm3, but that is not longer a dependency, so we don't need bindgen (directly) any more
2022-12-18 21:22:14 +01:00
Anton-4
706ecf063d
add zig version 2022-11-14 09:36:09 +01:00
Anton-4
410919cb39
removed Earthfile and references to it 2022-11-09 15:34:05 +01:00
Richard Feldman
f0b65048cd
Note that asking for help on Zulip is fastest
Signed-off-by: Richard Feldman <oss@rtfeldman.com>
2022-10-24 21:40:05 -04:00
Anton-4
e97de12476
installing nixFlakes is no longer necessary
Signed-off-by: Anton-4 <17049058+Anton-4@users.noreply.github.com>
2022-10-04 14:42:06 +02:00
Anton-4
f2c7fb8b09
windows BUILDING_FROM_SOURCE update
Signed-off-by: Anton-4 <17049058+Anton-4@users.noreply.github.com>
2022-09-10 17:17:51 +02:00
Jan Van Bruggen
8bbfd68621
Add language to all fenced code blocks
See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md040
2022-09-09 01:12:31 -06:00
Jan Van Bruggen
9cf7bdcccf
Use dashes for list markers
See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md004
2022-09-09 01:12:31 -06:00
Jan Van Bruggen
3902668ce5
Add angle brackets to bare URLs
See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md034
2022-09-09 01:12:30 -06:00
Jan Van Bruggen
26a1abfea8
Add blank lines around lists
See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md032
2022-09-07 23:18:03 -06:00
Jan Van Bruggen
e3071a22b0
Add blank lines around headings
See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md022
2022-09-07 23:18:03 -06:00
Jan Van Bruggen
6229eb54ca
Add blank lines around fenced code blocks
See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md031
2022-09-07 23:18:03 -06:00
Folkert
ac3c5e2fdb
further additions for building on windows 2022-09-02 20:36:31 +02:00
Anton-4
34de640003
better windows setup instructions
Signed-off-by: Anton-4 <17049058+Anton-4@users.noreply.github.com>
2022-09-02 19:42:56 +02:00
Anton-4
4bfd892d7f
better nix wsl instructions
Signed-off-by: Anton-4 <17049058+Anton-4@users.noreply.github.com>
2022-08-30 17:04:33 +02:00
Anton-4
aefa55e313
improve nix advice
Signed-off-by: Anton-4 <17049058+Anton-4@users.noreply.github.com>
2022-08-30 11:04:05 +02:00
Anton-4
42804cca5b
mention nix GLIBC version error
This error may occur frequently enough that it's worth mentioning in BUILDING_FROM_SOURCE

Signed-off-by: Anton-4 <17049058+Anton-4@users.noreply.github.com>
2022-08-22 12:00:02 +02:00
Anton-4
3e14512e49
mention to install bindgen 2022-08-01 15:26:05 +02:00
Anton-4
899fda0d0e
Added dev tools flake + instructions 2022-07-23 18:15:52 +02:00
Brian Carroll
d6757ea7b0
Merge pull request #3279 from rtfeldman/windows_build_fixes
fix non-linking cargo build error on windows
2022-06-20 23:03:37 +01:00
Anton-4
67629f8908
fix non-linking cargo build errors on windows 2022-06-20 17:21:28 +02:00
Anton-4
28fecb97e1
minor re-organize BUILDING_FROM_SOURCE 2022-06-17 19:32:49 +02:00
Anton-4
0d16cdcfa3
cleaner way to run editor from nix 2022-06-14 17:26:46 +02:00
Anton-4
0fe0d852d7
improve wording 2022-05-27 12:02:06 +02:00
Anton-4
27ac7dcea2
deprecated shell.nix, updated BUILDING_FROM_SOURCE 2022-05-27 11:59:05 +02:00
Anton-4
b041a5f5be
Merge branch 'trunk' of github.com:rtfeldman/roc into nix_flake_M1 2022-05-13 12:17:20 +02:00
Richard Feldman
572ebaff8b
Merge pull request #3054 from rtfeldman/nix-editor
Fixed nix editor instructions
2022-05-11 16:06:49 -04:00
Anton-4
8cd68a05e4
Merge branch 'trunk' of github.com:rtfeldman/roc into nix_flake_M1 2022-05-11 16:39:10 +02:00
Anton-4
b091c1e68b
fixed nix editor instructions 2022-05-11 13:09:54 +02:00
Anton-4
1b10106039
updated nix editor instructions 2022-05-10 14:25:13 +02:00
Anton-4
29be9b42c1
updated remaining references to llvm12 2022-05-09 15:57:08 +02:00
Folkert
b6a47223b7
remove mentions of llvm-as 2022-05-07 20:49:44 +02:00
Folkert
70d94ccceb
update llvm and zig verson in BUILDING_FROM_SOURCE 2022-05-07 20:14:51 +02:00
Anton-4
d01861badc
updated BUILDING_FROM_SOURCE 2022-04-23 11:08:08 +02:00
Kas Buunk
8a16c963d1
chore: correct typo in docs 2022-04-18 07:11:31 +02:00
Kevin Gillette
1c3700e22e
Minor typo/formatting fixes 2022-04-11 19:11:37 -06:00
Nikita Mounier
94df530a8d
Change wording using @rtfeldman suggestion.
Co-authored-by: Richard Feldman <oss@rtfeldman.com>
2022-04-09 11:07:00 +00:00
Nikita Mounier
fa527b1888
Specify that in nix-shell's PATH, usr/bin needs to come after nix-related components
This was the source of quite a head-scratching error when building the compiler, only solved thanks to @ayazhafiz 's insight. Indeed, compilation of `roc_cli` was failing with an obscure error about linking with `cc` and not being able to find `-ltinfo`. Turns out the fix is as trivial as rearranging nix-shell's `PATH` a little.
I feel like nix-shell will become the default for many users who prefer delegating the necessary setup to the repo's script, and I definitely wish I had known about this when I was starting out.

Is this the right place to mention this or should it be somewhere else in the document?
2022-04-08 20:43:58 +00:00
Anton-4
d389178126
markdown cleanup 2022-03-16 19:37:33 +01:00