Skip to content

Commit

Permalink
Merge pull request #36 from SquitchYT/dev-config-usage
Browse files Browse the repository at this point in the history 
Dev config usage
  • Loading branch information
@SquitchYT
SquitchYT authored Jun 29, 2023
2 parents a5d4551 + 6d3eaba commit 5d14f84
Show file tree
Hide file tree
Showing 28 changed files with 1,157 additions and 327 deletions.
97 changes: 69 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

# Why another terminal?

Tess was mainly built in order to offer you a new, intuitive, fully customizable and blazing fast terminal app, by using the power of web technologies.
Tess was mainly built in order to offer you a new, intuitive, fully customizable, and blazing fast terminal app by using the power of web technologies.

Why should you not test it? We work for more than 2 years on this, and we've been relied on by thousands of users.
Why should you not test it? We've worked on this for more than 2 years, and we've been relied on by thousands of users.

Tess is currently officially tested on Windows & Linux, but it should work also on other platform.
If you cannot have access to Tess yet, fill an issue, we'll try to provide you the best cross-platform experience by making new packages or helping you manually installing Tess.
Tess is currently officially tested on Windows and Linux, but it should also work on other platforms.
If you do not have access to Tess yet, fill out an issue, and we'll try to provide you with the best cross-platform experience by making new packages or helping you manually install Tess.

<br>
<br>
Expand All @@ -21,13 +21,15 @@ If you cannot have access to Tess yet, fill an issue, we'll try to provide you t

<br>

## Installation from archive
## Installation from the archive

We provide package for most major distribution, simply select the one that match your distro and install it.
We provide packages for most major distributions; simply select the one that matches your distro and install it.

<br>

## Installation with PPA

If you prefer using apt over downloading and installing the `deb` archive. You could set up the PPA and download Tess with these
If you prefer using apt over downloading and installing the `deb` archive, you could set up the PPA and download Tess with these
```bash
apt install curl apt-transport-https gnupg2

Expand All @@ -38,14 +40,20 @@ echo 'deb [signed-by=/usr/share/keyrings/tess.gpg] https://apt.tessapp.dev stabl
apt update && apt install tess
```

<br>

## Installation with AUR

On Arch Linux, the recommended way to install Tess is using an AUR package manager like [yay](https://github.com/Jguer/yay)
`yay -S tess-git`
On Arch Linux, the recommended way to install Tess is to use an AUR package manager like [yay](https://github.com/Jguer/yay)
```sh
yay -S tess-git
```

<br>

## Installation with RPM repository

If you are on RHEL derivate distros, you could also want to add our RPM repository to install Tess and receive update automatically with your package manager
If you are on RHEL-derived distros, you may also want to add our RPM repository to install Tess and receive updates automatically with your package manager.

```bash
yum install curl
Expand All @@ -66,27 +74,33 @@ yum check-update && yum install tess

## Installation from Installer

Simply download and execute the installer, available in the [releases](https://github.com/SquitchYT/Tess/releases) page.
Simply download and execute the installer, available on the [releases](https://github.com/SquitchYT/Tess/releases) page.

<br>

## Installation using Winget

If you are running on `Windows 10 1709 (build 16299)` or superior, you could download [Winget](https://github.com/microsoft/winget-cli). It may also be already installed on your system.<br>
Next, execute the following command
<br>

If you are running on `Windows 10 1709 (build 16299)` or superior, you could download [Winget](https://github.com/microsoft/winget-cli). It may also already be installed on your system.<br>
Next, execute the following command.

```sh
winget install Squitch.Tess
```

<br>

## Installation using Chocolatey

Firstly, download [Chocolatey](https://chocolatey.org/install).<br>
Next, you will be allowed to run this
Next, you will be allowed to run this.

```sh
choco install tess
```

You can also find the package [here](https://community.chocolatey.org/packages/tess)
You can also find the package [here](https://community.chocolatey.org/packages/tess).

<br>
<br>
Expand All @@ -95,32 +109,59 @@ You can also find the package [here](https://community.chocolatey.org/packages/t

## Getting started

You want to contribute in Tess, find a simple task to help us with this project.
If you want to contribute to Tess, find a simple task to help us with this project.

* You've found a mistake in documentations, code or in the wiki, let us know by opening an [issue](https://github.com/SquitchYT/Tess/issues).
* You've an amazing feature idea, simply post your suggestion by creating an issue too.
* You want to help us close an issue, implementing a feature or something else related to code, follow the guide below.
* If you've found a mistake in documentation, sources, or the wiki, let us know by opening an [issue](https://github.com/SquitchYT/Tess/issues).
* You've got an amazing feature idea; simply post your suggestion by creating an issue too.
* You want to help us close an issue, implement a feature, or do something else related to code, follow the guide below.

*Please, search for a similar issue before creating a new one.*

<br>

## Developing with Tess

You want to contribute to Tess, it's simply, fork the repository and start developing on it.
First and foremost, you need to ensure that you have installed the necessary tools:

* [Rust & Cargo](https://rustup.rs/)
* [Node.js](https://nodejs.org/en)
* Tauri CLI `cargo install tauri-cli`

<br>

Next, start by downloading the source code.
```sh
git clone -b dev https://github.com/SquitchYT/Tess
```

Next, set up the project.
```sh
npm i
```

To ensure that everything is set up properly, run Tess with this command; it should launch Tess.
```sh
cargo tauri dev
```

You are now ready!

<br>

Important notice:

* As Tess is cross-platform, when you implement a new feature, try to make it available everywhere. If despite all your efforts, you are unable to make it cross-platform, let us know the supported platforms when submitting your changes.
* If you update code, explain why you think this change is important and what you've done.
* As Tess is cross-platform, when you implement a new feature, try to make it available everywhere. If, despite all your efforts, you are unable to make it cross-platform, let us know the supported platforms when submitting your changes.
* If you update the code, explain why you think this change is important and what you've done.

After making your changes, simply open a [pull request](https://github.com/SquitchYT/Tess/pulls).
Simply open a [pull request](https://github.com/SquitchYT/Tess/pulls) to submit your changes.

<br>
<br>

# Roadmap

As long as Tess is in beta, many bugs may occur and some of them have not yet been fixed.<br>
More, many features are not yet available, here's a quick recap of major features that will want to integrate in Tess.
As long as Tess is in beta, many bugs may occur, and some of them have not yet been fixed.<br>
Many features are not yet available; here's a quick recap of the major features that we'll integrate in Tess.


|Features |Electron|Tauri|
Expand All @@ -131,15 +172,15 @@ More, many features are not yet available, here's a quick recap of major feature
|Administrator tabs |❌ |⌛ |
|Tabs split |❌ |⌛ |
|Command line interface |✔️ |⌛ |
|Notifications |❌ |⌛ |
|Notifications |❌ |🟠 |
|Macros |❌ |⌛ |
|Plugins |🟠 |⌛ |
|Themes |🟠 |⌛ |
|Themes |🟠 |🟠 |
|Config page |✔️ |⌛ |
|Config watching |🟠 |⌛ |
|Image display |❌ |⌛ |
|Font ligature |🟠 |⌛ |
|Animated background |❌ |⌛ |
|Animated background |❌ |✔️ |
|URI scheme API |❌ |⌛ |
|Search in a shell |❌ |⌛ |
|Marketplace |❌ |⌛ |
Expand Down
Loading

0 comments on commit 5d14f84

Please sign in to comment.