From 25ae844d555b489eebd1ca3e80cc34f67182e205 Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Tue, 20 Dec 2016 11:20:08 -0800 Subject: [PATCH] Rename to CircuitPython --- README.md | 18 +++++++++--------- index.rst | 10 ++++------ lib/utils/pyexec.c | 6 +++--- shared-module/help.c | 4 ++-- 4 files changed, 18 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 0d1dbc81d4b5..dd950bc04ca2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Adafruit MicroPython +# Adafruit CircuitPython -[![Build Status](https://travis-ci.org/adafruit/micropython.svg?branch=master)](https://travis-ci.org/adafruit/micropython) +[![Build Status](https://travis-ci.org/adafruit/circuitpython.svg?branch=master)](https://travis-ci.org/adafruit/circuitpython) This is an open source derivative of [MicroPython](http://www.micropython.org) for use on educational development boards designed and sold by Adafruit @@ -11,19 +11,19 @@ As a MicroPython derivative, this implements Python 3.x on microcontrollers such as the SAMD21 and ESP8266. ## Project Status -This project is in beta and the APIs will change in the near future. +This project is in beta. Most APIs should be stable going forward. ## Documentation -Guides and videos are available through the [Adafruit Learning System](https://learn.adafruit.com/) under the [MicroPython category](https://learn.adafruit.com/category/micropython). An API reference is also available on [Read the Docs](http://adafruit-micropython.readthedocs.io/en/latest/?). +Guides and videos are available through the [Adafruit Learning System](https://learn.adafruit.com/) under the [CircuitPython category](https://learn.adafruit.com/category/circuitpython). An API reference is also available on [Read the Docs](http://circuitpython.readthedocs.io/en/latest/?). ## Contributing -See [CONTRIBUTING.md](https://github.com/adafruit/micropython/blob/master/CONTRIBUTING.md) +See [CONTRIBUTING.md](https://github.com/adafruit/circuitpython/blob/master/CONTRIBUTING.md) for full guidelines but please be aware that by contributing to this project you are agreeing to the -[Code of Conduct](https://github.com/adafruit/micropython/blob/master/CODE_OF_CONDUCT.md). +[Code of Conduct](https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md). Contributors who follow the -[Code of Conduct](https://github.com/adafruit/micropython/blob/master/CODE_OF_CONDUCT.md) +[Code of Conduct](https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md) are welcome to submit pull requests and they will be promptly reviewed by project admins. @@ -31,7 +31,7 @@ project admins. Here is an overview of the top-level directories. ### Core -The core of MicroPython is code shared amongst ports. +The core code of MicroPython is shared amongst ports including CircuitPython: - `docs` High level user documentation in Sphinx reStructuredText format. - `drivers` External device drivers written in Python. - `examples` A few example Python scripts. @@ -63,4 +63,4 @@ based on the board. - `windows` Support for [Windows](https://www.microsoft.com/en-us/windows/). - `zephyr` Support for [Zephyr](https://www.zephyrproject.org/), a real-time operating system by the Linux Foundation. -This derivative only maintains the `atmel-samd` and `esp8266` ports. The rest are here to maintain compatibility with the [MicroPython](https://github.com/micropython/micropython) parent project. +CircuitPython only maintains the `atmel-samd` and `esp8266` ports. The rest are here to maintain compatibility with the [MicroPython](https://github.com/micropython/micropython) parent project. diff --git a/index.rst b/index.rst index e1b911249229..13be692a5205 100644 --- a/index.rst +++ b/index.rst @@ -1,7 +1,7 @@ -Adafruit MicroPython API Reference +Adafruit CircuitPython API Reference ======================================== -Welcome! This is the documentation for Adafruit MicroPython. It is an open +Welcome! This is the documentation for Adafruit CircuitPython. It is an open source derivative of `MicroPython `_ for use on educational development boards designed and sold by `Adafruit `_ including the `Arduino Zero @@ -10,10 +10,8 @@ educational development boards designed and sold by `Adafruit `_ and `Adafruit Feather M0 Bluefruit LE `_. -Adafruit's MicroPython port features a unified Python APIs available under -`!shared-bindings` and a growing list of drivers that work with it. Currently -only the Atmel SAMD21 port is supported but ESP8266 support will be added in the -near future. +Adafruit CircuitPython features unified Python hardware APIs available under +`!shared-bindings` and a growing list of drivers that work with it. `Adafruit `_ has many excellent tutorials available through the `Adafruit Learning System `_. These diff --git a/lib/utils/pyexec.c b/lib/utils/pyexec.c index 63797158ff4a..3c48a7d0debd 100644 --- a/lib/utils/pyexec.c +++ b/lib/utils/pyexec.c @@ -1,5 +1,5 @@ /* - * This file is part of the Micro Python project, http://micropython.org/ + * This file is part of the MicroPython project, http://micropython.org/ * * The MIT License (MIT) * @@ -245,7 +245,7 @@ STATIC int pyexec_friendly_repl_process_char(int c) { // reset friendly REPL mp_hal_stdout_tx_str("\r\n"); mp_hal_stdout_tx_str("\r\n"); - mp_hal_stdout_tx_str("Adafruit MicroPython " MICROPY_GIT_TAG " on " MICROPY_BUILD_DATE "; " MICROPY_HW_BOARD_NAME " with " MICROPY_HW_MCU_NAME "\r\n"); + mp_hal_stdout_tx_str("Adafruit CircuitPython " MICROPY_GIT_TAG " on " MICROPY_BUILD_DATE "; " MICROPY_HW_BOARD_NAME " with " MICROPY_HW_MCU_NAME "\r\n"); // mp_hal_stdout_tx_str("Type \"help()\" for more information.\r\n"); goto input_restart; } else if (ret == CHAR_CTRL_C) { @@ -394,7 +394,7 @@ int pyexec_friendly_repl(void) { #endif friendly_repl_reset: - mp_hal_stdout_tx_str("\r\nAdafruit MicroPython " MICROPY_GIT_TAG " on " MICROPY_BUILD_DATE "; " MICROPY_HW_BOARD_NAME " with " MICROPY_HW_MCU_NAME "\r\n"); + mp_hal_stdout_tx_str("\r\nAdafruit CircuitPython " MICROPY_GIT_TAG " on " MICROPY_BUILD_DATE "; " MICROPY_HW_BOARD_NAME " with " MICROPY_HW_MCU_NAME "\r\n"); // mp_hal_stdout_tx_str("Type \"help()\" for more information.\r\n"); // to test ctrl-C diff --git a/shared-module/help.c b/shared-module/help.c index fbde9a7adab6..1e8f44c3e0ca 100644 --- a/shared-module/help.c +++ b/shared-module/help.c @@ -32,9 +32,9 @@ extern const mp_map_t mp_builtin_module_map; void shared_module_help(void) { mp_printf(&mp_plat_print, - "Welcome to Adafruit MicroPython " MICROPY_GIT_TAG "!\r\n" + "Welcome to Adafruit CircuitPython " MICROPY_GIT_TAG "!\r\n" "\r\n" - "Please visit learn.adafruit.com/category/micropython for project guides.\r\n" + "Please visit learn.adafruit.com/category/circuitpython for project guides.\r\n" "\r\n" "Built in modules:\r\n"); for (int i = 0; i < mp_builtin_module_map.used; i++) {