rename readme to contributing and expand it a bit

.vscode/extensions.json

@@ -3,11 +3,7 @@
     // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
 
     // List of extensions which should be recommended for users of this workspace.
-    "recommendations": [
-        "dbaeumer.vscode-eslint",
-        "esbenp.prettier-vscode",
-        "mrmlnc.vscode-json5"
-    ],
+    "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"],
     // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
     "unwantedRecommendations": []
 }

CONTRIBUTING.md

@@ -0,0 +1,122 @@
+
+
+# Development Environment
+
+These are the tools you will need to build and run `pybricks-code` locally.
+
+## IDE
+
+Technically you can use any text editor you like but the project is set up to
+use [VS Code][vscode]. The project includes some recommended extensions that
+will do nice things like automatically format the code for you.
+
+[vscode]: https://code.visualstudio.com/
+
+
+## Toolchain
+
+These are the required software tools you need to install on your computer.
+
+### Node.js
+
+We are using [Node.js][node] v10.x. We recommend using a tool such as [asdf][asdf]
+or [nvm][nvm] if you need to install more than one version of Node.js.
+
+[node]: https://nodejs.org/en/
+[asdf]: https://asdf-vm.com/
+[nvm]: https://github.com/nvm-sh/nvm
+
+### Yarn Package Manager
+
+We are using [Yarn][yarn] 1.x for package management.
+
+[yarn]: https://classic.yarnpkg.com/
+
+### Git Version Control
+
+You will need [Git][git] to get the source code from GitHub. (Say that 3 times fast!)
+
+[git]: https://git-scm.com/
+
+
+## Getting The Code
+
+After the tools above have been installed, open a command prompt in the directory
+where you would like to save the source code and run:
+
+    git clone https://github.com/pybricks/pybricks-code
+    cd pybricks-code
+    yarn install
+
+
+# Software Stack
+
+This project was bootstrapped with [Create React App][create-react-app].
+
+[create-react-app]: https://github.com/facebook/create-react-app
+
+
+## Available Scripts
+
+In the project directory, you can run:
+
+
+### `yarn start`
+
+Runs the app in the development mode.
+
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+If you default browser is not compatible (i.e. not chromium), create a file
+`.env.local` in the root directory with the full path to the browser:
+
+    BROWSER=<path-to-chromium>
+
+The page will reload if you make edits.
+
+You will also see any lint errors in the console.
+
+
+### `yarn lint`
+
+Runs the code linter.
+
+This will automatically fix most lint errors for you.
+
+
+### `yarn test`
+
+Launches the test runner in the interactive watch mode.
+
+See the section about [running tests][tests] for more information.
+
+[tests]: https://facebook.github.io/create-react-app/docs/running-tests
+
+
+### `yarn 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][deployment] for more information.
+
+[deployment]: https://facebook.github.io/create-react-app/docs/deployment
+
+
+## Learn More
+
+You can learn more in the [Create React App documentation][create-react-app-doc].
+
+[create-react-app-doc]: https://facebook.github.io/create-react-app/docs/getting-started
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+To learn React Redux, check out the [React Redux documentation](https://react-redux.js.org/)
+
+To learn Redux-Saga, checkout the [Redux-Saga documentation](https://redux-saga.js.org/)

README.md

@@ -1,44 +1,8 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+pybricks-code
+=============
 
-## Available Scripts
+A Web App for programming LEGO® Powered Up smart hubs using Pybricks MicroPython.
 
-In the project directory, you can run:
+---
 
-### `yarn start`
-
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
-
-### `yarn test`
-
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `yarn build`
-
-Builds the app for production to the `build` folder.<br />
-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.<br />
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn 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/).
+<small>LEGO® is a trademark of the LEGO Group of companies which does not sponsor, authorize or endorse this project</small>