Skip to content

Commit b977c1f

Browse files
committed
Update documentation
1 parent 9423b2a commit b977c1f

File tree

2 files changed

+22
-7
lines changed

2 files changed

+22
-7
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@
33
> #### Table of Contents
44
> - [Learning About Tracers](#learning-about-tracers)
55
> - [Running on Scratch Paper](#running-on-scratch-paper)
6+
> - [Directory Structures](#directory-structures)
67
> - [Creating a Pull Request](#creating-a-pull-request)
78
9+
Are you a first-timer in contributing to open source? [These guidelines](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) from GitHub might help!
10+
811
## Learning About Tracers
912

1013
The project [Algorithm Visualizer](https://github.com/algorithm-visualizer) has a visualization library in each supported language ([JavaScript](https://github.com/algorithm-visualizer/tracers.js), [C++](https://github.com/algorithm-visualizer/tracers.cpp), and [Java](https://github.com/algorithm-visualizer/tracers.java)) to visualize codes.
1114

12-
There are five tracers in the library to visualize different types of data.
15+
There are five tracers in the library to visualize different types of data:
1316

1417
- [Array1DTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/Array1DTracer)
1518
- [Array2DTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/Array2DTracer)
@@ -27,6 +30,21 @@ At the bottom left corner of [algorithm-visualizer.org](https://algorithm-visual
2730

2831
We highly encourage you to test your visualization on Scratch Paper several times before creating a pull request.
2932

33+
## Directory Structures
34+
35+
- **Category A/**
36+
- **Algorithm A/**
37+
- **code.js**
38+
- **code.cpp**
39+
- **code.java**
40+
- **README.md**
41+
- **Algorithm B/**
42+
- **Algorithm C/**
43+
- ...
44+
- **Category B/**
45+
- **Category C/**
46+
- ...
47+
3048
## Creating a Pull Request
3149

3250
1. Fork this repository.
@@ -41,7 +59,7 @@ We highly encourage you to test your visualization on Scratch Paper several time
4159
4260
3. Make changes.
4361

44-
Understand the [directory structure](https://github.com/algorithm-visualizer/algorithm-visualizer/blob/master/PROJECT_DETAILS.md#algorithms), and create or edit files accordingly.
62+
Understand the [directory structure](#directory-structures), and create or edit files accordingly.
4563

4664
If you want to create a directory, check out this [Stack Overflow answer](https://stackoverflow.com/questions/18773598/creating-folders-inside-github-com-repo-without-using-git).
4765

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# Algorithms
22

3-
> `algorithms` contains algorithm visualizations.
4-
5-
This repository is part of the project [Algorithm Visualizer](https://github.com/algorithm-visualizer).
6-
7-
All the codes here are visualized on [algorithm-visualizer.org](https://algorithm-visualizer.org/).
3+
> This repository is part of the project [Algorithm Visualizer](https://github.com/algorithm-visualizer).
84
5+
`algorithms` contains algorithm visualizations shown on the side menu of [algorithm-visualizer.org](https://algorithm-visualizer.org/).
96
The project currently supports JavaScript, C++, and Java.
107

118
## Contributing

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy