Skip to content

Commit

Permalink
update README with new GitHub markdown highlights
Browse files Browse the repository at this point in the history
  • Loading branch information
JaxonWright committed Feb 10, 2024
1 parent 55034dd commit 47430af
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,17 @@
> _sen·​ti·​nel sen-tə-nəl_
> _especially_ : a soldier standing guard at a point of passage (such as a gate)
> [!CAUTION]
> This project is still in its very early pages and does not currently function.
## About
A free, open-source Windows, macOS, and Linux application that allows you to efficiently view, manage, and export sentry and dashcam footage from your Tesla vehicle. It does require you to have access to the USB drive containing the footage, whether that be directly plugged into your computer or using a more complicated setup with a network share such as [TeslaUSB](https://github.com/cimryan/teslausb) or other similar setups.

## Preview
Nothing to show here...yet.

A better preview will be here when the project is functional

<img src="https://i.imgur.com/NfKVoVH.png" width="750">

## Install

Expand Down Expand Up @@ -45,7 +50,8 @@ To run a local developer instance of the application, run `npm run tauri dev` in

Read the [Tauri Documentation](https://tauri.app/v1/guides/development/development-cycle) on this for more info.

> **NOTE:** If you are on Linux, it may fail to launch when using the integrated VS Code terminal. This can be resolved by running in the native terminal. For some, running `unset GTK_PATH` within VS Code terminal fixes this issue as well.
> [!TIP]
> If you are on Linux, it may fail to launch when using the integrated VS Code terminal. This can be resolved by running in the native terminal. For some, running `unset GTK_PATH` within VS Code terminal fixes this issue as well.
If, for whatever reason, you do not want to run the application within Tauri, you may run `ng serve` to serve a local instance of just the Angular application in your web browser. There are no guarentees everything will work properly this way, though.

Expand Down

0 comments on commit 47430af

Please sign in to comment.