diff --git a/README.md b/README.md index 87e1e0edb..8f0a5a039 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,25 @@ -

- - - Wave Terminal Logo + + + Wave Terminal Logo

-# Wave Terminal +# Wave Terminal A open-source, cross-platform, AI-integrated, modern terminal for seamless workflows. -Wave isn't just another terminal emulator; it's a rethink on how terminals are built. Wave combines command line with the power of the open web to help veteran CLI users and new developers alike. +Wave isn't just another terminal emulator; it's a rethink on how terminals are built. Wave combines command line with the power of the open web to help veteran CLI users and new developers alike. -* Inline renderers to cut down on context switching. Render code, images, markdown, and CSV files without ever leaving the terminal. -* Persistent sessions that can restore state across network disconnections and reboots -* Searchable contextual command history across all remote sessions (saved locally) -* Workspaces, tabs, and command blocks to keep you organized -* AI Integration with ChatGPT (or ChatGPT compatible APIs) to help write commands and get answers inline +- Inline renderers to cut down on context switching. Render code, images, markdown, and CSV files without ever leaving the terminal. +- Persistent sessions that can restore state across network disconnections and reboots +- Searchable contextual command history across all remote sessions (saved locally) +- Workspaces, tabs, and command blocks to keep you organized +- AI Integration with ChatGPT (or ChatGPT compatible APIs) to help write commands and get answers inline + +![WaveTerm Screenshot](./assets/wave-screenshot.jpeg) ## Installation @@ -27,31 +28,30 @@ Wave Terminal works with MacOS and Linux (preliminary). Install Wave Terminal from: [www.waveterm.dev/download](https://www.waveterm.dev/download) Also available as a homebrew cask for MacOS: + ``` brew install --cask wave ``` ## Links -* Homepage — https://www.waveterm.dev -* Download Page — https://www.waveterm.dev/download -* Documentation — https://docs.waveterm.dev/ -* Blog — https://blog.waveterm.dev/ -* Quick Start Guide — https://docs.waveterm.dev/quickstart/ -* Discord Community — https://discord.gg/XfvZ334gwU +- Homepage — https://www.waveterm.dev +- Download Page — https://www.waveterm.dev/download +- Documentation — https://docs.waveterm.dev/ +- Blog — https://blog.waveterm.dev/ +- Quick Start Guide — https://docs.waveterm.dev/quickstart/ +- Discord Community — https://discord.gg/XfvZ334gwU ## Building from Source -* [MacOS Build Instructions](./BUILD.md) -* [Linux Build Instructions](./build-linux.md) +- [MacOS Build Instructions](./BUILD.md) +- [Linux Build Instructions](./build-linux.md) ## Contributing -Wave uses Github Project for tracking issues. +Wave uses Github Project for tracking issues. Find more information in our [Contributions Guide](CONTRIBUTING.md), which includes: - * [Ways to contribute](CONTRIBUTING.md#contributing-to-wave-terminal) - * [Contribution guidelines](CONTRIBUTING.md#before-you-start) - - +- [Ways to contribute](CONTRIBUTING.md#contributing-to-wave-terminal) +- [Contribution guidelines](CONTRIBUTING.md#before-you-start) diff --git a/assets/wave-logo_horizontal-coloronblack.svg b/assets/wave-logo_horizontal-coloronblack.svg new file mode 100644 index 000000000..132c6ad04 --- /dev/null +++ b/assets/wave-logo_horizontal-coloronblack.svg @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/wave-logo_horizontal-coloronwhite.svg b/assets/wave-logo_horizontal-coloronwhite.svg new file mode 100644 index 000000000..b081eefae --- /dev/null +++ b/assets/wave-logo_horizontal-coloronwhite.svg @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/wave-screenshot.jpeg b/assets/wave-screenshot.jpeg new file mode 100644 index 000000000..b1d84ae30 Binary files /dev/null and b/assets/wave-screenshot.jpeg differ diff --git a/assets/waveterm-logo-with-bg.svg b/assets/waveterm-logo-with-bg.svg new file mode 100644 index 000000000..0c137c9d7 --- /dev/null +++ b/assets/waveterm-logo-with-bg.svg @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/waveterm-logo.png b/assets/waveterm-logo.png new file mode 100644 index 000000000..daaf606e4 Binary files /dev/null and b/assets/waveterm-logo.png differ diff --git a/assets/waveterm-logo.svg b/assets/waveterm-logo.svg new file mode 100644 index 000000000..630fdfa63 --- /dev/null +++ b/assets/waveterm-logo.svg @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + +