Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tobinatore committed Sep 27, 2020
1 parent d23d7dd commit 31092f6
Showing 1 changed file with 37 additions and 33 deletions.
70 changes: 37 additions & 33 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,41 @@
# AlgoVis<span>.</span>io

## Table of Contents <!-- omit in toc -->

- [AlgoVis<span>.</span>io](#algovisio)
- [General](#general)
- [Introduction](#introduction)
- [Setup](#setup)
- [Algorithms](#algorithms)
- [Example visualizations](#example-visualizations)
- [Technical stuff](#technical-stuff)
- [Behind the visualizations](#behind-the-visualizations)
- [Documentation](#documentation)
- [Full list of algorithms and data structures](#full-list-of-algorithms-and-data-structures)
- [Sorting](#sorting)
- [Graphs](#graphs)
- [Pathfinding](#pathfinding)
- [Maze generation](#maze-generation)
- [Data structures](#data-structures)
- [Contributing](#contributing)

## General

### Introduction
<h1 align="center">
<img src="https://i.imgur.com/afQhzn9.png"> <br>
AlgoVis<span>.</span>io
</h1>
<h4 align="center">AlgoVis is a passion project aimed at helping everybody understand algorithms a little better by using easy to understand visualizations, concise explanations and dynamic code highlighting showing exactly what's happening.</h4>
<p align="center"><img src="https://img.shields.io/website?down_color=%23CC1616&down_message=offline&up_message=live&url=https%3A%2F%2Ftobinatore.github.io%2Falgovis%2F"> <img src="https://img.shields.io/github/v/release/tobinatore/algovis?color=%23CC1616"> <img src="https://img.shields.io/github/last-commit/tobinatore/algovis?color=%23CC1616"> <img src="https://img.shields.io/github/repo-size/tobinatore/algovis?color=%23CC1616"> </p>

## :bookmark_tabs: Table of Contents <!-- omit in toc -->

- [:v: General](#v-general)
- [:wave: Introduction](#wave-introduction)
- [:desktop_computer: Setup](#desktop_computer-setup)
- [:chart_with_upwards_trend: Algorithms](#chart_with_upwards_trend-algorithms)
- [:eyes: Example visualizations](#eyes-example-visualizations)
- [:technologist: Technical stuff](#technologist-technical-stuff)
- [:rocket: Behind the visualizations](#rocket-behind-the-visualizations)
- [:book: Documentation](#book-documentation)
- [:ballot_box_with_check: Full list of algorithms and data structures](#ballot_box_with_check-full-list-of-algorithms-and-data-structures)
- [Sorting](#sorting)
- [Graphs](#graphs)
- [Pathfinding](#pathfinding)
- [Maze generation](#maze-generation)
- [Data structures](#data-structures)
- [:memo: Contributing](#memo-contributing)

## :v: General

### :wave: Introduction

AlgoVis<span>.</span>io is an online algorithm visualization tool written using HTML, CSS, JS, jQuery and d3.js.

### Setup
### :desktop_computer: Setup

You do not need to download / clone / fork / whatever anything to test the website, as a live version can be found [on my GithubPages portfolio](https://tobinatore.github.io/algovis/)!

If you wish to have a local copy for testing all you need to do is fork and clone the repository. There are no complicated setup steps to get it up and running. You won't need a webserver as I'm not using php or any other server-side languages in this project.
If you wish to have a local copy for testing all you need to do is either fork and clone the repository if you want to contribute or download one of the releases found [here](https://github.com/tobinatore/algovis/releases) if you just want to play around with it. There are no complicated setup steps to get it up and running. You won't need a webserver as I'm not using php or any other server-side languages in this project.

### Algorithms
### :chart_with_upwards_trend: Algorithms

At the time of writing this readme, I've implemented visualizations for 24 algorithms in 3 categories and 4 data structures.

Expand All @@ -43,7 +47,7 @@ The 3 categories are:

A full list of all algorithms can be found under [Full list of algorithms](#Full-list-of-algorithms).

### Example visualizations
### :eyes: Example visualizations

Selection sort:
![Selection sort](https://i.imgur.com/gQMfbjx.gif)
Expand All @@ -60,17 +64,17 @@ Growing tree algorithm:
Stack:
![Stack](https://i.imgur.com/HV21dvo.gif)

## Technical stuff
## :technologist: Technical stuff

### Behind the visualizations
### :rocket: Behind the visualizations

I've made the visualizations using d3.js. All visualizations are contained in an \<svg> and are essentially just manipulations of svg elements. As this is the first time I've used d3.js, there's probably a lot of room for improvement in my code.

### Documentation
### :book: Documentation

I've written jsDoc comments for every class and module to make it easier to understand what everything does. You can find all auto-generated html files in the `documentation` folder.

### Full list of algorithms and data structures
### :ballot_box_with_check: Full list of algorithms and data structures

#### Sorting

Expand Down Expand Up @@ -115,6 +119,6 @@ I've written jsDoc comments for every class and module to make it easier to unde
- Linked list
- Stack

## Contributing
## :memo: Contributing

If you've found a bug or want to add an algorithm feel free to fork this repository and open pull requests :).

0 comments on commit 31092f6

Please sign in to comment.