Warp/README.md

87 lines
3.9 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">
<img width="612" alt="horz - dark" src="https://storage.googleapis.com/warpdotdev-content/warp_logo-21_10.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://www.warp.dev">Website</a>
2022-04-05 08:34:50 +03:00
·
<a href="https://docs.warp.dev">Docs</a>
·
<a href="https://docs.warp.dev/getting-started/getting-started-with-warp">Install Guide</a>
·
<a href="https://www.warp.dev/blog/how-warp-works">How Warp Works</a>
2022-04-05 08:34:50 +03:00
</p>
<a href="https://www.warp.dev">
<img width="1024" alt="Warp Terminal product preview" src="https://storage.googleapis.com/warpdotdev-content/warp-product-24_10.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
This is an issues-only repo for [Warp](https://www.warp.dev), a modern terminal with AI and your dev teams knowledge built-in.
2022-04-05 08:17:14 +03:00
Warp is:
* Built with Rust
* GPU-accelerated
* Compatible with zsh, bash, fish, and PowerShell
* Ready to use on MacOS and Linux ([Windows waitlist](https://www.warp.dev/windows-terminal))
## Installation
You can [download Warp](https://www.warp.dev/download) 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/getting-started/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)
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.
2. Join our [Discord](https://discord.gg/warpdotdev) to chat with other users and get immediate help from 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 to 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)