Skip to content
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.

Sign up for GitHub

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

Jump to bottom

merge queue: embarking main (41fabd5) and #4217 together #4374

Closed
wants to merge 6 commits into from
Closed

merge queue: embarking main (41fabd5) and #4217 together #4374

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d80cce0
docs: windows installation
Lancear Sep 19, 2023
96f8acc
docs: merge into development docs
Lancear Sep 26, 2023
1d4564e
docs: remove typo
Lancear Sep 26, 2023
3aef0ac
Update docs/contributing/01-start-here/05-development.md
Lancear Sep 30, 2023
7011a32
small fixes
Lancear Oct 2, 2023
3df6b4c
Merge of #4217
mergify[bot] Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/contributing/01-start-here/05-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,23 @@ keywords: [Wing contributors, contributors, workflows]

This topic includes a description of common development workflows for the Wing project.

## Environment Setup
## How to prepare for take-off? 🐤

:::info
You can open up this repo just using the badge below. It is recommended to select a 4-core minimum machine.
You can open up this repo by clicking the badge below. It is recommended to select a 4-core minimum machine.
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/winglang/wing)
:::

:::info
For windows we recommend to set the tools up within WSL as some of the scripts
don't support windows and expect unix tooling.

Some Guides:
- [💡 Setup WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command)
- [💡 Setup build essentials for rust](https://stackoverflow.com/questions/52445961/how-do-i-fix-the-rust-error-linker-cc-not-found-for-debian-on-windows-10)
- [💡 Enable systemd to install docker without the need of Docker Desktop](https://devblogs.microsoft.com/commandline/systemd-support-is-now-available-in-wsl/#how-can-you-get-systemd-on-your-machine)
:::

Here is a list of minimal tools you should install to build the Wing repo in your development
environment:

Expand All @@ -35,6 +45,7 @@ cd wing
pnpm install
```


:::note Turbo Commands
[Turbo] commands in this document are structured as

Expand All @@ -60,7 +71,6 @@ pnpm turbo <task> --filter=<project> -- <args>
[volta]: https://volta.sh
[PNPM]: https://pnpm.io
[Docker]: https://docs.docker.com/get-docker/
[emscripten]: https://emscripten.org/docs/getting_started/downloads.html

## Full build

Expand Down Expand Up @@ -102,7 +112,7 @@ Now, you can edit a source file anywhere across the stack and run the compiler w
For example:

```sh
pnpm wing -- test examples/tests/valid/captures.w
pnpm wing -- test examples/tests/valid/captures.test.w
```

This command runs the full Wing CLI with the given arguments. Turbo will ensure the CLI build is updated.
Expand Down
Loading