Skip to content

Commit ae88c6c

Browse files
bpmctbpmct
committed
wrap markdown
1 parent a16a04a commit ae88c6c

File tree

2 files changed

+54
-25
lines changed

2 files changed

+54
-25
lines changed

‎README.md

+28-12
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache
88
Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
99
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
1010

11-
Coder creates remote development machines so you can develop your code from anywhere. #coder
11+
Coder creates remote development machines so you can develop your code from
12+
anywhere. #coder
1213

13-
> **Note**:
14-
> Coder is in an alpha state, but any serious bugs are P1 for us so [please report them](https://github.com/coder/coder/issues/new/choose).
14+
> **Note**: Coder is in an alpha state, but any serious bugs are P1 for us so
15+
> [please report them](https://github.com/coder/coder/issues/new/choose).
1516
1617
<p align="center">
1718
<img src="./docs/images/hero-image.png">
@@ -41,24 +42,34 @@ product.
4142
<img src="./docs/images/providers-compute.png">
4243
</p>
4344

44-
Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
45-
and whatever else Terraform lets you dream up.
45+
Coder workspaces don't stop at compute. You can add storage buckets, secrets,
46+
sidecars and whatever else Terraform lets you dream up.
4647

4748
[Learn more about managing infrastructure.](./docs/templates.md)
4849

4950
## IDE Support
5051

51-
You can use any Web IDE ([code-server](https://github.com/coder/code-server), [projector](https://github.com/JetBrains/projector-server), [Jupyter](https://jupyter.org/), etc.), [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file sync such as [mutagen](https://mutagen.io/).
52+
You can use any Web IDE ([code-server](https://github.com/coder/code-server),
53+
[projector](https://github.com/JetBrains/projector-server),
54+
[Jupyter](https://jupyter.org/), etc.), [JetBrains
55+
Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code
56+
Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file
57+
sync such as [mutagen](https://mutagen.io/).
5258

5359
<p align="center">
5460
<img src="./docs/images/ide-icons.svg" height=72>
5561
</p>
5662

5763
## Installing Coder
5864

59-
There are a few ways to install Coder: [install script](./docs/install.md#installsh) (macOS, Linux), [docker-compose](./docs/install.md#docker-compose), or [manually](./docs/install.md#manual) via the latest release (macOS, Windows, and Linux).
65+
There are a few ways to install Coder: [install
66+
script](./docs/install.md#installsh) (macOS, Linux),
67+
[docker-compose](./docs/install.md#docker-compose), or
68+
[manually](./docs/install.md#manual) via the latest release (macOS, Windows, and
69+
Linux).
6070

61-
If you use the install script, you can preview what occurs during the install process:
71+
If you use the install script, you can preview what occurs during the install
72+
process:
6273

6374
```sh
6475
curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
@@ -70,7 +81,8 @@ To install, run:
7081
curl -fsSL https://coder.com/install.sh | sh
7182
```
7283

73-
Once installed, you can run a temporary deployment in dev mode (all data is in-memory and destroyed on exit):
84+
Once installed, you can run a temporary deployment in dev mode (all data is
85+
in-memory and destroyed on exit):
7486

7587
```sh
7688
coder server --dev
@@ -133,13 +145,17 @@ coder templates update gcp-linux
133145

134146
## Community
135147

136-
Join the community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq) #coder!
148+
Join the community on [Discord](https://discord.gg/coder) and
149+
[Twitter](https://twitter.com/coderhq) #coder!
137150

138-
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
151+
[Suggest improvements and report
152+
problems](https://github.com/coder/coder/issues/new/choose)
139153

140154
## Comparison
141155

142-
Please file [an issue](https://github.com/coder/coder/issues/new) if any information is out of date. Also refer to: [What Coder is not](./docs/about.md#what-coder-is-not).
156+
Please file [an issue](https://github.com/coder/coder/issues/new) if any
157+
information is out of date. Also refer to: [What Coder is
158+
not](./docs/about.md#what-coder-is-not).
143159

144160
| Tool | Type | Delivery Model | Cost | Environments |
145161
| :---------------------------------------------------------- | :------- | :----------------- | :---------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |

‎docs/install.md

+26-13
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# Install
22

3-
This article walks you through the various ways of installing and deploying Coder.
3+
This article walks you through the various ways of installing and deploying
4+
Coder.
45

56
## install.sh
67

7-
The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/main/install.sh) for Linux and macOS. The install script
8-
attempts to use the system package manager detection-reference if possible.
8+
The easiest way to install Coder is to use our [install
9+
script](https://github.com/coder/coder/main/install.sh) for Linux and macOS. The
10+
install script attempts to use the system package manager detection-reference if
11+
possible.
912

1013
You can preview what occurs during the install process:
1114

@@ -24,15 +27,17 @@ curl -L https://coder.com/install.sh | sh
2427
> post](https://sandstorm.io/news/2015-09-24-is-curl-bash-insecure-pgp-verified-install)
2528
> by [sandstorm.io](https://sandstorm.io).
2629
27-
You can modify the installation process by including flags. Run the help command for reference:
30+
You can modify the installation process by including flags. Run the help command
31+
for reference:
2832

2933
```bash
3034
curl -L https://coder.com/install.sh | sh -s -- --help
3135
```
3236

3337
## System packages
3438

35-
Coder publishes the following system packages [in GitHub releases](https://github.com/coder/coder/releases):
39+
Coder publishes the following system packages [in GitHub
40+
releases](https://github.com/coder/coder/releases):
3641

3742
- .deb (Debian, Ubuntu)
3843
- .rpm (Fedora, CentOS, RHEL, SUSE)
@@ -47,7 +52,8 @@ sudo vim /etc/coder.d/coder.env
4752
sudo service coder restart
4853
```
4954

50-
Or run a **temporary deployment** with dev mode (all data is in-memory and destroyed on exit):
55+
Or run a **temporary deployment** with dev mode (all data is in-memory and
56+
destroyed on exit):
5157

5258

5359
```sh
@@ -56,8 +62,8 @@ coder server --dev
5662

5763
## docker-compose
5864

59-
Before proceeding, please ensure that you have both Docker and the [latest version of
60-
Coder](https://github.com/coder/coder/releases) installed.
65+
Before proceeding, please ensure that you have both Docker and the [latest
66+
version of Coder](https://github.com/coder/coder/releases) installed.
6167

6268
1. Clone the `coder` repository:
6369

@@ -96,22 +102,29 @@ Coder](https://github.com/coder/coder/releases) installed.
96102

97103
## Manual
98104

99-
We publish self-contained .zip and .tar.gz archives in [GitHub releases](https://github.com/coder/coder/releases). The archives bundle `coder` binary.
105+
We publish self-contained .zip and .tar.gz archives in [GitHub
106+
releases](https://github.com/coder/coder/releases). The archives bundle `coder`
107+
binary.
100108

101-
1. Download the [release archive](https://github.com/coder/coder/releases) appropriate for your operating system
109+
1. Download the [release archive](https://github.com/coder/coder/releases)
110+
appropriate for your operating system
102111

103-
1. Unzip the folder you just downloaded, and move the `coder` executable to a location that's on your `PATH`
112+
1. Unzip the folder you just downloaded, and move the `coder` executable to a
113+
location that's on your `PATH`
104114

105115
```sh
106116
# ex. MacOS and Linux
107117
mv coder /usr/local/bin
108118
```
109119

110-
> Windows users: see [this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23) for adding folders to `PATH`.
120+
> Windows users: see [this
121+
> guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23)
122+
> for adding folders to `PATH`.
111123

112124
1. Start a Coder server
113125

114-
To run a **temporary deployment**, start with dev mode (all data is in-memory and destroyed on exit):
126+
To run a **temporary deployment**, start with dev mode (all data is
127+
in-memory and destroyed on exit):
115128

116129
```bash
117130
coder server --dev

0 commit comments

Comments
 (0)