From a4663cd3130416ae53393bc4e0ac599d10b61213 Mon Sep 17 00:00:00 2001 From: "[poww10s]" <[theironminer@gmail.com]> Date: Wed, 18 Nov 2020 03:04:21 -0500 Subject: [PATCH] update README for Branch --- .gitignore | 1 + README.md | 74 +++++++++--------------------------------------------- 2 files changed, 13 insertions(+), 62 deletions(-) diff --git a/.gitignore b/.gitignore index 5c0ce75..cb5c809 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ node_modules # production /build +React_README.md # misc .DS_Store diff --git a/README.md b/README.md index d8b522c..3744900 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,18 @@ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), using the [Redux](https://redux.js.org/) and [Redux Toolkit](https://redux-toolkit.js.org/) template. +# Alapatch :musical_keyboard: -## Available Scripts +Alapatch is a Patch Editor for the KORG microKorg Synthesizer, that allows you to design patches in a web editor with an easy to use GUI. -In the project directory, you can run: +Alapatch currently only supports loading and saving patch files in the .SYSEX format used internally in the microKORG, however future support for the .plg format may be a possibility. (because it needs to be reverse engineered still.) -### `npm start` +# Branch TODO List -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +- [x] implement React Redux Correctly +- [ ] finish implementing for each component +- [ ] finish one timbre as an example +- [ ] update state and components to handle multiple timbres +- [ ] style components +- [ ] merge with main branch -The page will reload if you make edits.
-You will also see any lint errors in the console. +# Link to the MicroKORG Midi Implementation -### `npm test` - -Launches the test runner in the interactive watch mode.
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. - -### `npm run build` - -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `npm run eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting - -### Analyzing the Bundle Size - -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size - -### Making a Progressive Web App - -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app - -### Advanced Configuration - -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration - -### Deployment - -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment - -### `npm run build` fails to minify - -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify +http://i.korg.com/uploads/Support/MK1_633652915168960000.pdf