Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
Docs for project
  • Loading branch information
bryanlundberg authored Oct 23, 2023
1 parent 3d9b406 commit 42fe988
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## This folder contains:
This directory contains the following subfolders, each serving a specific purpose:
|Folder| Contents |
|--|--|
| `./algs` | Algorithm sets for OLL, PLL, COLL, CMLL. |
| `./app` | Next.js application router. |
| `./components` | Reusable components and feature components. |
| `./hooks` | Logic related to `useState`, `useEffect`, etc. |
| `./icons` | Icons for various purposes (solid and outline). |
| `./images` | General images used throughout the project. |
| `./lib` | Multipurpose functions used in the project. |
| `./store` | Global state management for the application. |
| `./translations` | Language translations. |

0 comments on commit 42fe988

Please sign in to comment.