From 18de2edf6b629e843ee4bcedfa2208d22b253f0f Mon Sep 17 00:00:00 2001 From: Thomas Yao <101596949+thomasthomas882@users.noreply.github.com> Date: Sat, 18 Nov 2023 10:28:48 -0500 Subject: [PATCH] Update README.md (#367) imrpoved the readme file by clarifying and imrpoving the readbility of frameworks and languages necessary to do the project. --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 76882fef..b0d31141 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,47 @@ # Algorithm Visualizer -> Algorithm Visualizer is an interactive online platform that visualizes algorithms from code. +## Introduction +Welcome to Algorithm Visualizer, an interactive online platform designed to bring algorithms to life through visualization. Whether you're a student, teacher, or professional, our platform provides an engaging way to explore and understand various algorithms. [![GitHub contributors](https://img.shields.io/github/contributors/algorithm-visualizer/algorithm-visualizer.svg?style=flat-square)](https://github.com/algorithm-visualizer/algorithm-visualizer/graphs/contributors) [![GitHub license](https://img.shields.io/github/license/algorithm-visualizer/algorithm-visualizer.svg?style=flat-square)](https://github.com/algorithm-visualizer/algorithm-visualizer/blob/master/LICENSE) +## Languages and Frameworks Used +[![Languages](https://skillicons.dev/icons?i=html,css,js,react,nodejs,redux)](https://skillicons.dev) + + +## Key Features + + +## algorithms +In this repository, you'll find visualizations of algorithms showcased in the website's side menu. Contributions here directly impact the educational content available on the platform. https://github.com/algorithm-visualizer/algorithms + + + +## tracers +Explore the various visualization libraries in different programming languages. These libraries extract visualization commands from code. +https://github.com/search?q=topic%3Avisualization-library+org%3Aalgorithm-visualizer&type=Repositories + + +## Live Demo Learning an algorithm gets much easier with visualizing it. Don't get what we mean? Check it out: [**algorithm-visualizer.org**![Screenshot](https://raw.githubusercontent.com/algorithm-visualizer/algorithm-visualizer/master/branding/screenshot.png)](https://algorithm-visualizer.org/) ## Contributing -We have multiple repositories under the hood that comprise the website. Take a look at the contributing guidelines in the repository you want to contribute to. +Our project consists of multiple repositories, each playing a crucial role in the Algorithm Visualizer ecosystem. If you're interested in contributing, check out the guidelines for the specific repository: + - [**`algorithm-visualizer`**](https://github.com/algorithm-visualizer/algorithm-visualizer) is a web app written in React. It contains UI components and interprets commands into visualizations. Check out [the contributing guidelines](CONTRIBUTING.md). @@ -20,3 +50,5 @@ We have multiple repositories under the hood that comprise the website. Take a l - [**`algorithms`**](https://github.com/algorithm-visualizer/algorithms) contains visualizations of algorithms shown on the side menu of the website. - [**`tracers.*`**](https://github.com/search?q=topic%3Avisualization-library+org%3Aalgorithm-visualizer&type=Repositories) are visualization libraries written in each supported language. They extract visualizing commands from code. + +Ready to contribute? Explore the repositories and become part of the Algorithm Visualizer community! \ No newline at end of file