Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/components/App/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { AlgorithmApi, GitHubApi, VisualizationApi } from 'apis';
import { actions } from 'reducers';
import { createUserFile, extension, refineGist } from 'common/util';
import { exts, languages } from 'common/config';
import { CONTRIBUTING_MD } from 'files';
import { SCRATCH_PAPER_README_MD } from 'files';
import styles from './App.module.scss';

class App extends BaseComponent {
Expand Down Expand Up @@ -163,7 +163,7 @@ class App extends BaseComponent {
login: undefined,
gistId,
title: 'Untitled',
files: [CONTRIBUTING_MD, createUserFile('visualization.json', JSON.stringify(content))],
files: [SCRATCH_PAPER_README_MD, createUserFile('visualization.json', JSON.stringify(content))],
});
});
} else if (gistId === 'new') {
Expand All @@ -172,7 +172,7 @@ class App extends BaseComponent {
login: undefined,
gistId,
title: 'Untitled',
files: [CONTRIBUTING_MD, language.skeleton],
files: [SCRATCH_PAPER_README_MD, language.skeleton],
});
} else if (gistId) {
return GitHubApi.getGist(gistId, { timestamp: Date.now() })
Expand Down
4 changes: 2 additions & 2 deletions src/components/Header/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,10 @@ class Header extends BaseComponent {
<Button className={styles.btn_dropdown} icon={user.avatar_url}>
{user.login}
<div className={styles.dropdown}>
<ListItem label="Sign Out" href="/api/auth/destroy" rel="nofollow"/>
<ListItem label="Sign Out" href="/api/auth/destroy" rel="opener"/>
</div>
</Button> :
<Button icon={faGithub} primary href="/api/auth/request" rel="nofollow">
<Button icon={faGithub} primary href="/api/auth/request" rel="opener">
<Ellipsis>Sign In</Ellipsis>
</Button>
}
Expand Down
4 changes: 2 additions & 2 deletions src/files/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ const readUserFile = filePath => createUserFile(getName(filePath), getContent(fi
export const CODE_CPP = readUserFile('skeletons/code.cpp');
export const CODE_JAVA = readUserFile('skeletons/code.java');
export const CODE_JS = readUserFile('skeletons/code.js');
export const README_MD = readProjectFile('algorithm-visualizer/README.md');
export const CONTRIBUTING_MD = readProjectFile('scratch-paper/CONTRIBUTING.md');
export const ROOT_README_MD = readProjectFile('algorithm-visualizer/README.md');
export const SCRATCH_PAPER_README_MD = readProjectFile('scratch-paper/README.md');
1 change: 0 additions & 1 deletion src/files/scratch-paper/CONTRIBUTING.md

This file was deleted.

28 changes: 28 additions & 0 deletions src/files/scratch-paper/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Scratch Paper

Visualize your own code here!

## Learning About Tracers

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.

There are five tracers in the library to visualize different types of data:

- [Array1DTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/Array1DTracer)
- [Array2DTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/Array2DTracer)
- [ChartTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/ChartTracer)
- [GraphTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/GraphTracer)
- [LogTracer](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki/LogTracer)

There are also randomizers to help you create random data.

Check out the [API reference](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki) for more information.

## Making Your Visualization Public

If you think other people would find your visualization useful, you can add it to the side menu
by [contributing to `algorithm-visualizer/algorithms`](https://github.com/algorithm-visualizer/algorithms/blob/master/CONTRIBUTING.md)
.
4 changes: 2 additions & 2 deletions src/reducers/current.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { combineActions, createAction, handleActions } from 'redux-actions';
import { README_MD } from 'files';
import { ROOT_README_MD } from 'files';
import { extension, isSaved } from 'common/util';

const prefix = 'CURRENT';
Expand Down Expand Up @@ -37,7 +37,7 @@ export const actions = {
};

const homeTitles = ['Algorithm Visualizer'];
const homeFiles = [README_MD];
const homeFiles = [ROOT_README_MD];
const homeDescription = 'Algorithm Visualizer is an interactive online platform that visualizes algorithms from code.';
const defaultState = {
algorithm: {
Expand Down