diff --git a/README.md b/README.md index f9165f4f8..a32d26c6a 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,65 @@ -# The Next Wave +

+ + + + Wave Terminal Logo + +
+

-Prereqs: +# Wave Terminal -You'll need to install "task" (which we're using as a build/run system): +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwavetermdev%2Fwaveterm.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fwavetermdev%2Fwaveterm?ref=badge_shield) -```sh +Wave is an open-source terminal that can launch graphical widgets, controlled and integrated directly with the CLI. It includes a base terminal, directory browser, file previews (images, media, markdown), a graphical editor (for code/text files), a web browser, and integrated AI chat. + +Wave isn't just another terminal emulator; it's a rethink on how terminals are built. For too long there has been a disconnect between the CLI and the web. If you want fast, keyboard-accessible, easy-to-write applications, you use the CLI, but if you want graphical interfaces, native widgets, copy/paste, scrolling, variable font sizes, then you'd have to turn to the web. Wave's goal is to bridge that gap. + +![WaveTerm Screenshot](./assets/wave-screenshot.png) + +## Installation + +Wave Terminal works on MacOS, Linux, and Windows. + +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/ +- Discord Community — https://discord.gg/XfvZ334gwU + +## Building from Source + +We use `task` to build Wave. + +```bash brew install go-task ``` -On first checkout: +Once task is installed you can run this command to build and launch the development version of Wave. Note that the development database and settings are kept in a separate folder from the production version (~/.waveterm-dev) to prevent cross-corruption. -```sh -yarn -go mod tidy -``` - -Then, run the following command to start the app using the Vite dev server (this will enable Hot Module Reloading): - -```sh +```bash task electron:dev ``` -To run the app without the dev server, run the following instead: +## Contributing -```sh -task electron:start -``` +Wave uses Github Issues for issue tracking. + +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) + +## License + +Wave Terminal is licensed under the Apache-2.0 License. For more information on our dependencies, see [here](./acknowledgements/README.md). diff --git a/assets/wave-screenshot.png b/assets/wave-screenshot.png new file mode 100644 index 000000000..920e95380 Binary files /dev/null and b/assets/wave-screenshot.png differ