Skip to content

Commit

Permalink
feat(repo): add videos showcasing functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
hwittenborn committed Aug 1, 2024
1 parent 715ccfc commit 60995dd
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
<div align="center">
<h1>Citadel</h1>
<img src ="/citadel.png" alt="Citadel profile image" height="200em">
<img src ="/assets/citadel.png" alt="Citadel profile image" height="200em">
</div>
<br>

Citadel is *the* Discord bot to use at your next study jam. It incorporates the best parts of services such as Quizlet and Kahoot, and combines them into a seamless interface that everyone can use (well, people that have Discord anyway).

Current features include:
- Automatic test generation from chat history. No longer shall you manually type in your questions πŸ₯³
- Kahoot-styled quizzes. Challenge your friends to a game to see who really knows their stuff πŸ§‘β€πŸ’»

**Automatic test generation from chat history. No longer shall you manually type in your questions πŸ₯³**
![Generate Command](/assets/generate.gif)

**Kahoot-styled quizzes. Challenge your friends to a game to see who really knows their stuff πŸ§‘β€πŸ’»**
![Quiz Command](/assets/quiz.gif)

## Running the bot
Setting up the bot is a fairly simple procedure, though it requires a few steps:
Expand Down
File renamed without changes
Binary file added assets/generate.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/quiz.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 60995dd

Please sign in to comment.