Skip to content

Commit de9a53f

Browse files
committed
delete some todos
1 parent c543412 commit de9a53f

File tree

1 file changed

+9
-53
lines changed

1 file changed

+9
-53
lines changed

todo.md

+9-53
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,11 @@
4242

4343
* Write tests and benchmark performance.
4444

45-
- Find and optimize areas of slow performance.
46-
4745
* Custom callbacks for error in getUserMedia when it is not available (i.e. in Safari)
4846

4947
* Documentation:
50-
- Fix [pause page](http://p5js.org/reference/#/p5.SoundFile/pause)
5148
- Make sure there are no looping sounds in the reference examples.
5249
- Lower amplitude on all examples
53-
- Improve documentation and examples when you see anything that is unclear.
5450

5551
- Update p5.FFT API to reflect [changes in the Processing Sound FFT API](https://github.com/processing/processing-docs/issues/221)
5652

@@ -70,23 +66,15 @@ AFTER HERE, COPIED FROM WIKI PAGE ON 2023-02-18
7066

7167
# p5.js-sound to do list
7268

73-
# Contribute
74-
75-
_If you have contributions, feedback, bug reports, or ideas to share, get involved! [Join the discussion on github](https://github.com/processing/p5.js-sound/issues) to let the community know what you plan to work on (and to make sure we're not already working on it). There is plenty to do...check out the [to do list](https://github.com/processing/p5.js-sound/blob/main/todo.md)._
76-
7769
# Installation
7870

79-
1. [Fork](https://help.github.com/articles/fork-a-repo) the library to your own github account
80-
2. Open up the terminal, and clone the library to your local computer
81-
```
82-
git clone https://github.com/<your github username>/p5.js-sound
83-
```
84-
3. Navigate to within the `p5.js-sound` folder. You can type `cd` (change directory) and then drag the folder into the terminal window to copy the address of the folder.
85-
4. Install the following dependencies:
86-
- [`npm`](https://www.npmjs.com/) (Node Package Manager). The easiest way to do this is by installing [node.js](http://nodejs.org/), which automatically installs `npm` for you.
87-
- [`grunt`](https://gruntjs.com/) command line interface. This is the task runner we use to build the library from source files. Install from the command line using npm: `sudo npm install -g grunt-cli`.
88-
5. Run `npm install` from the command line. This downloads the node modules that we use to build the `p5.sound.js` file from the source files in the `/src` folder, as well as modules used for running tests and other tasks.
89-
6. Run `grunt` from the command line to compile the library. This will update the p5.sound.js and p5.sound.min.js files in the `/lib` directory with any changes from the `/src` directory.
71+
- Clone this repo and navigate to within the `p5.js-sound` folder. You can type `cd` (change directory) and then drag the folder into the terminal window to copy the address of the folder.
72+
- Install the following dependencies:
73+
- [`npm`](https://www.npmjs.com/) (Node Package Manager). The easiest way to do this is by installing [node.js](http://nodejs.org/), which automatically installs `npm` for you.
74+
- [`grunt`](https://gruntjs.com/) command line interface. This is the task runner we use to build the library from source files. Install from the command line using npm: `sudo npm install -g grunt-cli`.
75+
76+
* Run `npm install` from the command line. This downloads the node modules that we use to build the `p5.sound.js` file from the source files in the `/src` folder, as well as modules used for running tests and other tasks.
77+
* Run `grunt` from the command line to compile the library. This will update the p5.sound.js and p5.sound.min.js files in the `/lib` directory with any changes from the `/src` directory.
9078

9179
# Overview
9280

@@ -104,12 +92,10 @@ Once you are set up, you can make changes in a variety of ways:
10492

10593
- **Adding features** Simply find the module you want to edit by looking for its files in the `/src` folder. Then, re-build the library by calling `grunt` from the command line when you are ready to try out your changes.
10694

107-
- **Writing documentation** `p5.js-sound` uses inline documentation. A good example for how to format and write inline documentation can be seen in [p5.Oscillator](https://github.com/processing/p5.js-sound/blob/main/src/oscillator.js). Check out the [documentation page](https://github.com/processing/p5.js-sound/wiki/Documentation) for more details.
95+
- **Writing documentation** `p5.js-sound` uses inline documentation. A good example for how to format and write inline documentation can be seen in [p5.Oscillator](https://github.com/processing/p5.js-sound/blob/main/src/oscillator.js).
10896

10997
- **Writing automatic tests** More information [below](#testing).
11098

111-
To submit your changes, commit your work and push your changes to your fork. Then [submit a pull request](https://help.github.com/articles/creating-a-pull-request) to merge your changes into the main branch.
112-
11399
# Testing
114100

115101
Ideally, all new functions will be implemented with unit tests and inline documentation. Examples of unit tests can be found in the [tests](https://github.com/processing/p5.js-sound/tree/main/test/tests) directory. Directions for adding your own tests and including them are below.
@@ -127,7 +113,7 @@ To get started:
127113
3. Register your new test files by adding their names to the `allTests` array in `test.js`.
128114
4. Run the tests in the browser (see below).
129115

130-
#### Running tests in the browser
116+
### Running tests in the browser
131117

132118
It is useful to run tests in the browser, especially when trying to debug test failures on different browsers. To run the tests in the browser:
133119

@@ -145,15 +131,6 @@ Linting rules are in this file: `src/.eslintrc`.
145131
3. You can auto-fix errors on the terminal, with the optional `--fix` flag that will fix some (but not all) linting errors. For example, to fix the errors in `src/audioin.js`, run `eslint src/audioin.js --fix` which will fix all the auto-fixable errors in that file.
146132
4. Alternatively (or for the non-auto-fixable errors), you can open those files and fix those errors manually.
147133

148-
#### (Optional but recommended) Get linting hints in your IDE
149-
150-
To get linting hints as you code, you can also install linter tools for your code editor. You will need to look up the instructions for setup in your own editor, but most modern editors support linting.
151-
152-
Some helpful links:
153-
154-
- [eslint integrations](http://eslint.org/docs/user-guide/integrations)
155-
- [EditorConfig](http://editorconfig.org/#download)
156-
157134
# Main branch development
158135

159136
0. **Install System Tools:**
@@ -213,35 +190,14 @@ Some helpful links:
213190
- `git push <name_of_the_remote> <branch_name>`
214191
- `git checkout -b <topic-branch-name>` Create a new branch and check it out
215192
- `git stash` Stash all uncommitted changes you’ve made to the branch. You can get them back later.
216-
- `git log` Show commit history.
217-
- `git status` Show branch and pending changes.
218-
- `git diff` View merge conflicts
219-
- `git grep "something()"` Search for things in your working directory.
220193
- `git commit --amend` Amend your previous commit rather than creating a new commit
221194

222195
# Addendum:
223196

224-
## Resolving Merge Conflicts:
225-
226-
- Conflicts occur when branches have conflicting modifications that cannot be automatically resolved/merged. When you try to merge (i.e. pull upstream changes), if there are conflicts, git tells you and adds this stuff to your file:
227-
228-
```
229-
<<<<<<< HEAD
230-
231-
Here is what you had locally
232-
=======
233-
Here is what was in the thing you tried to merge
234-
>>>>>>> 59685c301d09b58fdac23d616
235-
```
236-
237-
You can fix manually by picking which one you want and getting rid of all this: <<<<<< HEAD ======= >>>>> 583….
238-
239197
DOCUMENTATION
240198

241199
The documentation that appears at https://p5js.org/reference/#/libraries/p5.sound is all generated automatically from inline comments. This happens once a new version of the p5.sound library is merged into the p5.js repo and included in a [release](https://github.com/processing/p5.js/releases).
242200

243-
You can write documentation by following the [p5.js documentation guide](https://github.com/processing/p5.js/blob/master/contributor_docs/inline_documentation.md). The only difference is that you'll be modifying source files that live here, in the p5.sound repo (i.e. `p5.js-sound/src/...`). Then, you'll move over to the p5.js repo to generate and view what your documentation changes will look like.
244-
245201
### Preview documentation
246202

247203
1. Clone the p5.js-sound repo and install all packages.

0 commit comments

Comments
 (0)