Skip to content

Commit 47747ed

Browse files
Minimal docs + license.
1 parent fde60fd commit 47747ed

File tree

2 files changed

+45
-25
lines changed

2 files changed

+45
-25
lines changed

LICENSE

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Copyright (c) 2021 Micro:bit Educational Foundation
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of
4+
this software and associated documentation files (the "Software"), to deal in
5+
the Software without restriction, including without limitation the rights to
6+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
7+
the Software, and to permit persons to whom the Software is furnished to do so,
8+
subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
15+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
16+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
17+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
18+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,31 @@
1-
# Getting Started with Create React App
1+
# Early development version of the next micro:bit Python editor
22

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
3+
This project is a web-based editor that targets the [MicroPython](https://micropython.org) version of the [Python programming language](http://python.org/). Code written with this editor is expected to run on the [BBC micro:bit device](https://microbit.org).
44

5-
## Available Scripts
5+
**The currently supported micro:bit Python editor is available at https://python.microbit.org/ and its source code can be found in GitHub at https://github.com/bbcmicrobit/PythonEditor.**
66

7-
In the project directory, you can run:
7+
**This project is an early development version of the next version of the editor.**
8+
9+
**It is not yet ready for use.**
10+
11+
## Developing the editor
12+
13+
The editor is written in TypeScript using React.
14+
15+
To learn React, check out the [React documentation](https://reactjs.org/).
16+
17+
To learn TypeScript, check out the [TypeScript documentation](https://www.typescriptlang.org/).
18+
19+
This early prototype uses the [Chakra UI](https://chakra-ui.com/) component library.
20+
21+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
22+
23+
## Building and running the editor
24+
25+
1. Ensure you have a working Node.js environment. We recommend using the LTS version of Node.
26+
2. Checkout this repository.
27+
3. Install the dependencies via `npm install`.
28+
4. Choose from the NPM scripts documented below.
829

930
### `npm start`
1031

@@ -19,28 +40,9 @@ You will also see any lint errors in the console.
1940
Launches the test runner in the interactive watch mode.\
2041
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
2142

43+
If you have a connected micro:bit device then setting the environment variable `TEST_MODE_DEVICE=1` will enable additional tests that will connect to your micro:bit. The tests will overwrite programs and data on the micro:bit.
44+
2245
### `npm run build`
2346

2447
Builds the app for production to the `build` folder.\
2548
It correctly bundles React in production mode and optimizes the build for the best performance.
26-
27-
The build is minified and the filenames include the hashes.\
28-
Your app is ready to be deployed!
29-
30-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
31-
32-
### `npm run eject`
33-
34-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
35-
36-
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.
37-
38-
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.
39-
40-
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.
41-
42-
## Learn More
43-
44-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45-
46-
To learn React, check out the [React documentation](https://reactjs.org/).

0 commit comments

Comments
 (0)