Skip to content

Commit

Permalink
chore(docs): add windows installation guide (#4217)
Browse files Browse the repository at this point in the history
- Inform the reader to install within wsl on windows
- Add some guides for wsl specific issues
- Remove an unused link
- Update wording for the codespace badge

## Checklist

- [x] Title matches [Winglang's style guide](https://www.winglang.io/contributing/start-here/pull_requests#how-are-pull-request-titles-formatted)
- [x] Description explains motivation and solution
- [x] Tests added (always)
- [x] Docs updated (only required for features)
- [x] Added `pr/e2e-full` label if this feature requires end-to-end testing

*By submitting this pull request, I confirm that my contribution is made under the terms of the [Wing Cloud Contribution License](https://github.com/winglang/wing/blob/main/CONTRIBUTION_LICENSE.md)*.
  • Loading branch information
Lancear authored Oct 2, 2023
1 parent 41fabd5 commit 3df70f9
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions docs/contributing/01-start-here/05-development.md
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

0 comments on commit 3df70f9

Please sign in to comment.