Warp/README.md

91 lines
4.3 KiB
Markdown
Raw Normal View History

2022-04-05 08:34:50 +03:00
<p align="center">
<a href="https://app.warp.dev/get_warp">
2023-10-11 23:41:39 +03:00
<img width="500" alt="horz - dark" src="https://storage.googleapis.com/warpdotdev-content/warp-github-dark.png">
2022-04-23 10:09:45 +03:00
</a>
2022-04-05 08:34:50 +03:00
</p>
<p align="center">
<a href="https://warp.dev">Website</a>
·
<a href="https://warp.dev/warp-drive">Warp Drive</a>
·
<a href="https://warp.dev/warp-ai">Warp AI</a>
·
<a href="#installation">Installation</a>
2022-04-05 08:34:50 +03:00
·
<a href="https://warp.dev/blog">Blog</a>
</p>
<a href="https://www.youtube.com/watch?v=34INSNevPOk">
2024-01-08 20:34:07 +03:00
<img width="1025" alt="Warp Terminal product preview" src="https://storage.googleapis.com/warpdotdev-content/warp-product-24_01.png">
2022-04-23 10:10:44 +03:00
</a>
2022-04-05 08:52:46 +03:00
2022-04-05 08:39:03 +03:00
<h1></h1>
## About
2022-04-05 08:13:30 +03:00
This is an issues-only repo for [Warp](https://www.warp.dev), a [blazingly-fast modern Rust based GPU-accelerated terminal](https://www.warp.dev/blog/how-warp-works) built to make [you and your team more productive.](https://www.warp.dev/blog/how-we-design-warp-our-product-philosophy)
2021-07-08 22:30:02 +03:00
## Supported Platforms
2022-04-05 08:05:20 +03:00
As of Feb 2024, Warp is available to macOS and Linux users, without joining a wait-list.
2021-07-08 22:30:02 +03:00
2022-04-05 08:17:14 +03:00
We are calling this new phase of the product our “public beta” its a “beta” because we know there are still some issues to smooth out, but we are confident that even today the experience is meaningfully better than in other terminals.
We have plans to support [Windows](https://www.warp.dev/windows-terminal) and the Web (WASM)!
## Installation
You can [download Warp](https://app.warp.dev/get_warp) and [read our docs](https://docs.warp.dev/getting-started/getting-started-with-warp) for platform-specific instructions.
2022-01-20 21:41:29 +03:00
## Changelog and Releases
2022-04-05 08:05:20 +03:00
We try to release an update weekly, typically on Thursdays. Read our [changelog (release notes).](https://docs.warp.dev/help/changelog)
2021-07-08 22:30:02 +03:00
2022-04-05 08:13:30 +03:00
## Issues, Bugs, and Feature Requests
2022-04-05 08:05:20 +03:00
Please [search](https://github.com/warpdotdev/warp/issues?q=is%3Aissue+is%3Aopen+a+sort%3Areactions-%2B1-desc) through our existing issues for your bug (including workarounds) or feature request.
If you can't find a solution above, please file issue requests [in this repo!](https://github.com/warpdotdev/warp/issues/new/choose)
We kindly ask that you please use our issue templates to make the issues easier to track for our team.
2021-07-08 22:30:02 +03:00
2022-04-05 08:13:30 +03:00
## Open Source & Contributing
We are planning to first open-source our Rust UI framework, and then parts and potentially all of our client codebase. The server portion of Warp will remain closed-source for now.
2022-04-05 08:13:30 +03:00
You can see how were thinking about open source here: [https://github.com/warpdotdev/Warp/discussions/400](https://github.com/warpdotdev/Warp/discussions/400)
2022-04-05 08:41:40 +03:00
As a side note, we are open sourcing our extension points as we go. The community has already been [contributing new themes](https://github.com/warpdotdev/themes). And weve just opened our [Workflows repository](https://github.com/warpdotdev/workflows) for the community to contribute common useful commands.
2021-07-08 22:30:02 +03:00
Interested in joining the team? See our [open roles](https://www.warp.dev/careers) and feel free to email us: hello at warpdotdev
2021-07-08 22:30:02 +03:00
## Support and Questions
2022-09-28 03:31:31 +03:00
1. See our [docs](https://docs.warp.dev/) for a walk-through of the features within our app.
2022-01-20 21:41:29 +03:00
2. Join our [Discord](https://discord.gg/warpdotdev) to chat with other users and get immediate help with members of the Warp team.
2021-07-08 22:30:02 +03:00
2022-01-23 03:02:23 +03:00
For anything else, please don't hesitate to reach out via email at hello at warpdotdev
2021-07-08 22:30:02 +03:00
## Community Guidelines
At a high level, we ask everyone be respectful and empathetic. We follow the [GitHub Community Guidelines](https://docs.github.com/en/github/site-policy/github-community-guidelines):
2022-04-05 08:05:20 +03:00
2021-07-08 22:30:02 +03:00
* Be welcoming and open-minded
* Respect each other
* Communicate with empathy
* Be clear and stay on topic
2021-07-16 01:16:09 +03:00
## Open Source Dependencies
2022-01-20 21:41:29 +03:00
We'd like to call out a few of the [open source dependencies](https://docs.warp.dev/help/licenses) that have helped Warp to get off the ground:
2021-07-16 01:16:09 +03:00
* [Tokio](https://github.com/tokio-rs/tokio)
* [NuShell](https://github.com/nushell/nushell)
* [Fig Completion Specs](https://github.com/withfig/autocomplete)
* [Warp Server Framework](https://github.com/seanmonstar/warp)
* [Alacritty](https://github.com/alacritty/alacritty)
* [Hyper HTTP library](https://github.com/hyperium/hyper)
* [FontKit](https://github.com/servo/font-kit)
* [Core-foundation](https://github.com/servo/core-foundation-rs)
* [Smol](https://github.com/smol-rs/smol)