Skip to content

Commit 1ba4644

Browse files
committed
Add README.md to scratch paper
1 parent 9ba0abc commit 1ba4644

File tree

5 files changed

+35
-8
lines changed

5 files changed

+35
-8
lines changed

src/components/App/index.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { AlgorithmApi, GitHubApi, VisualizationApi } from 'apis';
1818
import { actions } from 'reducers';
1919
import { createUserFile, extension, refineGist } from 'common/util';
2020
import { exts, languages } from 'common/config';
21-
import { CONTRIBUTING_MD } from 'files';
21+
import { SCRATCH_PAPER_README_MD } from 'files';
2222
import styles from './App.module.scss';
2323

2424
class App extends BaseComponent {
@@ -163,7 +163,7 @@ class App extends BaseComponent {
163163
login: undefined,
164164
gistId,
165165
title: 'Untitled',
166-
files: [CONTRIBUTING_MD, createUserFile('visualization.json', JSON.stringify(content))],
166+
files: [SCRATCH_PAPER_README_MD, createUserFile('visualization.json', JSON.stringify(content))],
167167
});
168168
});
169169
} else if (gistId === 'new') {
@@ -172,7 +172,7 @@ class App extends BaseComponent {
172172
login: undefined,
173173
gistId,
174174
title: 'Untitled',
175-
files: [CONTRIBUTING_MD, language.skeleton],
175+
files: [SCRATCH_PAPER_README_MD, language.skeleton],
176176
});
177177
} else if (gistId) {
178178
return GitHubApi.getGist(gistId, { timestamp: Date.now() })

src/files/index.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ const readUserFile = filePath => createUserFile(getName(filePath), getContent(fi
88
export const CODE_CPP = readUserFile('skeletons/code.cpp');
99
export const CODE_JAVA = readUserFile('skeletons/code.java');
1010
export const CODE_JS = readUserFile('skeletons/code.js');
11-
export const README_MD = readProjectFile('algorithm-visualizer/README.md');
12-
export const CONTRIBUTING_MD = readProjectFile('scratch-paper/CONTRIBUTING.md');
11+
export const ROOT_README_MD = readProjectFile('algorithm-visualizer/README.md');
12+
export const SCRATCH_PAPER_README_MD = readProjectFile('scratch-paper/README.md');

src/files/scratch-paper/CONTRIBUTING.md

-1
This file was deleted.

src/files/scratch-paper/README.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Scratch Paper
2+
3+
Visualize your own code here!
4+
5+
## Learning About Tracers
6+
7+
The project [Algorithm Visualizer](https://github.com/algorithm-visualizer) has a visualization library in each
8+
supported language ([JavaScript](https://github.com/algorithm-visualizer/tracers.js)
9+
, [C++](https://github.com/algorithm-visualizer/tracers.cpp),
10+
and [Java](https://github.com/algorithm-visualizer/tracers.java)) to visualize codes.
11+
12+
There are five tracers in the library to visualize different types of data:
13+
14+
- [Array1DTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/Array1DTracer)
15+
- [Array2DTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/Array2DTracer)
16+
- [ChartTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/ChartTracer)
17+
- [GraphTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/GraphTracer)
18+
- [LogTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/LogTracer)
19+
20+
There are also randomizers to help you create random data.
21+
22+
Check out the [API reference](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki) for more information.
23+
24+
## Making Your Visualization Public
25+
26+
If you think other people would find your visualization useful, you can add it to the side menu
27+
by [contributing to `algorithm-visualizer/algorithms`](https://github.com/algorithm-visualizer/algorithms/blob/master/CONTRIBUTING.md)
28+
.

src/reducers/current.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { combineActions, createAction, handleActions } from 'redux-actions';
2-
import { README_MD } from 'files';
2+
import { ROOT_README_MD } from 'files';
33
import { extension, isSaved } from 'common/util';
44

55
const prefix = 'CURRENT';
@@ -37,7 +37,7 @@ export const actions = {
3737
};
3838

3939
const homeTitles = ['Algorithm Visualizer'];
40-
const homeFiles = [README_MD];
40+
const homeFiles = [ROOT_README_MD];
4141
const homeDescription = 'Algorithm Visualizer is an interactive online platform that visualizes algorithms from code.';
4242
const defaultState = {
4343
algorithm: {

0 commit comments

Comments
 (0)