Skip to content

Commit 06f0568

Browse files
committed
fix: add missing readme to root
1 parent f4a061f commit 06f0568

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

README.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Coder
2+
3+
[!["GitHub
4+
Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/coder/discussions)
5+
[!["Join us on
6+
Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache=true&logo=discord&colorB=purple)](https://discord.gg/coder)
7+
[![Twitter
8+
Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
9+
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
10+
11+
Coder creates remote development machines so your team can develop from anywhere.
12+
13+
<p align="center">
14+
<img src="./docs/images/hero-image.png">
15+
</p>
16+
17+
**Manage less**
18+
19+
- Ensure your entire team is using the same tools and resources
20+
- Rollout critical updates to your developers with one command
21+
- Automatically shut down expensive cloud resources
22+
- Keep your source code and data behind your firewall
23+
24+
**Code more**
25+
26+
- Build and test faster
27+
- Leveraging cloud CPUs, RAM, network speeds, etc.
28+
- Access your environment from any place on any client (even an iPad)
29+
- Onboard instantly then stay up to date continuously
30+
31+
## Getting Started
32+
33+
> **Note**:
34+
> Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new).
35+
36+
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).
37+
38+
If you use the install script, you can preview what occurs during the install process:
39+
40+
```sh
41+
curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
42+
```
43+
44+
To install, run:
45+
46+
```sh
47+
curl -fsSL https://coder.com/install.sh | sh
48+
```
49+
50+
Once installed, you can run a temporary deployment in dev mode (all data is in-memory and destroyed on exit):
51+
52+
```sh
53+
coder server --dev
54+
```
55+
56+
Use `coder --help` to get a complete list of flags and environment variables. Use our [quickstart guide](./docs/quickstart.md) for a full walkthrough.
57+
58+
## Documentation
59+
60+
Visit our docs [here](./docs/index.md).
61+
62+
## Comparison
63+
64+
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).
65+
66+
| Tool | Type | Delivery Model | Cost | Environments |
67+
| :---------------------------------------------------------- | :------- | :----------------- | :---------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
68+
| [Coder](https://github.com/coder/coder) | Platform | OSS + Self-Managed | Pay your cloud | All [Terraform](https://www.terraform.io/registry/providers) resources, all clouds, multi-architecture: Linux, Mac, Windows, containers, VMs, amd64, arm64 |
69+
| [code-server](https://github.com/cdr/code-server) | Web IDE | OSS + Self-Managed | Pay your cloud | Linux, Mac, Windows, containers, VMs, amd64, arm64 |
70+
| [Coder (Classic)](https://coder.com/docs) | Platform | Self-Managed | Pay your cloud + license fees | Kubernetes Linux Containers |
71+
| [GitHub Codespaces](https://github.com/features/codespaces) | Platform | SaaS | 2x Azure Compute | Linux containers |
72+
73+
---
74+
75+
_Last updated: 5/27/22_
76+
77+
## Community and Support
78+
79+
Join our community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq)!
80+
81+
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
82+
83+
## Contributing
84+
85+
Read the [contributing docs](./docs/CONTRIBUTING.md).
86+
87+
Find our list of contributors [here](./docs/CONTRIBUTORS.md).

0 commit comments

Comments
 (0)