Skip to content

Commit 06be496

Browse files
committed
Improve wordings in documentations
1 parent cd1d30d commit 06be496

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
## Running Locally
88

9-
1. Fork the main repo.
9+
1. Fork this repository.
1010

1111
2. Clone your forked repo to your machine.
1212

PROJECT_DETAILS.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99
1010
## Project Structure
1111

12-
The project [algorithm-visualizer](https://github.com/algorithm-visualizer) consists of the following 3 repos.
12+
The project [algorithm-visualizer](https://github.com/algorithm-visualizer) consists of the following three repositories.
1313

14-
- [algorithms](https://github.com/algorithm-visualizer/algorithms) contains public algorithms shown on the sidebar.
14+
- [`algorithms`](https://github.com/algorithm-visualizer/algorithms) contains public algorithms shown on the sidebar.
1515

16-
- [tracers](https://github.com/algorithm-visualizer/tracers) builds visualization libraries for each supported language based on the specifications, and executes users' codes to extract visualization data.
16+
- [`tracers`](https://github.com/algorithm-visualizer/tracers) builds visualization libraries for each supported language based on the specifications, and executes users' codes to extract visualization data.
1717

18-
- [algorithm-visualizer](https://github.com/algorithm-visualizer/algorithm-visualizer) contains the frontend server written in React and the backend server written in Node.
18+
- [`algorithm-visualizer`](https://github.com/algorithm-visualizer/algorithm-visualizer) contains the frontend server written in React and the backend server written in Node.
1919

2020
## Directory Structures
2121

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
55
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/algorithm-visualizer)
66
[![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)
7-
[![GitHub](https://img.shields.io/github/license/algorithm-visualizer/algorithm-visualizer.svg?style=flat-square)](https://github.com/algorithm-visualizer/algorithm-visualizer/blob/master/LICENSE)
7+
[![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)
88

9-
Learning algorithms from text and static images is quite boring. For that, there have been many great websites that view animations of various algorithms. However, for us being coders, nothing can be more comprehensible than visualizing the actual working code. So here we introduce Algorithm Visualizer.
9+
Learning algorithms from text and static images is quite boring. There have been many great websites that view animations of various algorithms though, for us being coders, nothing can be more comprehensible than visualizing the actual working code.
1010

1111
[![Screenshot](https://raw.githubusercontent.com/algorithm-visualizer/algorithm-visualizer/master/branding/screenshot.png)](https://algorithm-visualizer.org/)
1212

@@ -22,7 +22,7 @@ Learning algorithms from text and static images is quite boring. For that, there
2222

2323
**I want to enhance visualization libraries.**
2424

25-
- It is highly recommended to read the entire [project details](https://github.com/algorithm-visualizer/algorithm-visualizer/blob/master/PROJECT_DETAILS.md) before working on it. Making changes to visualization libraries often requires quite a lot of work since you may need to work on all of 3 repositories: [`algorithms`](https://github.com/algorithm-visualizer/algorithms), [`tracers`](https://github.com/algorithm-visualizer/tracers), and [`algorithm-visualizer`](https://github.com/algorithm-visualizer/algorithm-visualizer). We encourage you to raise an issue about your idea of enhancement before working on it.
25+
- It is highly recommended to read the entire [project details](https://github.com/algorithm-visualizer/algorithm-visualizer/blob/master/PROJECT_DETAILS.md) before working on it. Making changes to visualization libraries often requires a lot of work since you may need to work on all of the following repositories: [`algorithms`](https://github.com/algorithm-visualizer/algorithms), [`tracers`](https://github.com/algorithm-visualizer/tracers), and [`algorithm-visualizer`](https://github.com/algorithm-visualizer/algorithm-visualizer). We encourage you to raise an issue about your idea of enhancement before working on it.
2626

2727
**I have a question in regards to contributing.**
2828

0 commit comments

Comments
 (0)