Skip to content

Commit

Permalink
docs: add details to README
Browse files Browse the repository at this point in the history
  • Loading branch information
polyesterswing committed Dec 29, 2024
1 parent d199374 commit fc3924e
Showing 1 changed file with 14 additions and 39 deletions.
53 changes: 14 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<a href="https://dscvit.com">
<img width="400" src="https://user-images.githubusercontent.com/56252312/159312411-58410727-3933-4224-b43e-4e9b627838a3.png#gh-light-mode-only" alt="GDSC VIT"/>
</a>
<h2 align="center"> < Insert Project Title Here > </h2>
<h4 align="center"> < Insert Project Description Here > <h4>
<h2 align="center"> AsciiFlix </h2>
<h4 align="center"> play videos in the terminal <h4>
</p>

---
Expand All @@ -14,53 +14,28 @@
[![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](INSERT_UI_LINK_HERE)


## Features
- [ ] < feature >
- [ ] < feature >
- [ ] < feature >
- [ ] < feature >

<br>

## Dependencies
- < dependency >
- < dependency >


## Running


< directions to install >
First, build the program with
```bash
< insert code >
cargo build --release
```

< directions to execute >
then run the program with

```bash
< insert code >
cargo run <video file>
```

## Contributors
## Controls
q - quit

space - pause

l - slow down by 2x

j - speed up by 2x

<table>
<tr align="center">
<td>
John Doe
<p align="center">
<img src = "https://dscvit.com/images/dsc-logo-square.svg" width="150" height="150" alt="Your Name Here (Insert Your Image Link In Src">
</p>
<p align="center">
<a href = "https://github.com/person1">
<img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/>
</a>
<a href = "https://www.linkedin.com/in/person1">
<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
</td>
</tr>
</table>

<p align="center">
Made with ❤ by <a href="https://dscvit.com">GDSC-VIT</a>
Expand Down

0 comments on commit fc3924e

Please sign in to comment.