Skip to content

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also compare across forks.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also compare across forks.
...
  • 2 commits
  • 2 files changed
  • 0 commit comments
  • 1 contributor
Commits on Jan 18, 2012
@mbolivar mbolivar framework/.gitignore: Ignore cscope files.
Ignore files output by cscope (see http://cscope.sourceforge.net/ for
more information).

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
247b521
@mbolivar mbolivar Add readme.md.
This is a top-level README in Markdown format.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
cca711d
Showing with 72 additions and 0 deletions.
  1. +2 −0 framework/.gitignore
  2. +70 −0 readme.md
View
2 framework/.gitignore
@@ -0,0 +1,2 @@
+cscope.files
+cscope.out
View
70 readme.md
@@ -0,0 +1,70 @@
+Wiring: an open-source programming framework for microcontrollers.
+
+Wiring has three major components:
+
+* The Wiring Language: A thin layer on top of C++ which simplifies the
+ process of writing embedded programs.
+
+* The Wiring Framework: A C and C++ API for writing embedded programs,
+ either using C++ or the Wiring Language. Currently, a implementation
+ of the Wiring framework exists for 8-bit AVR
+ microcontrollers. Support for the STM32 line of ARM Cortex M3 and M4
+ microcontrollers is in progress.
+
+* Wiring IDE: A cross-platform Integrated Development Environment
+ (IDE) used to write, compile, and upload programs written in the
+ Wiring language to boards which support the Wiring Framework.
+
+This source code repository contains the Wiring Framework and the
+Wiring IDE.
+
+Getting Wiring
+==============
+
+This is the source code repository for the Wiring IDE and Wiring
+Framework. If you just want to write and upload programs, your best
+bet is to download an existing binary release. These are available at
+the Wiring web site for Windows, Mac, and Linux:
+
+ http://wiring.org.co/download/
+
+If you are interested in developing Wiring, you'll need to build the
+IDE using this repository. For more information, see the file
+build/howto.txt (in this repository).
+
+Developing Wiring
+=================
+
+Development discussion takes place on
+wiring-dev@yahoogroups.ca. Please ask any development-related
+questions there. To subscribe, send email to:
+
+ wiring-dev-subscribe@yahoogroups.ca.
+
+Archives are available online at:
+
+ http://ca.groups.yahoo.com/group/wiring-dev/
+
+The developers' portal on the Wiring Wiki is here:
+
+ http://wiki.wiring.co/wiki/Develop_Wiring
+
+Repository Structure
+====================
+
+The Wiring repository structure is as follows:
+
+* IDE/: Contains the Java sources for the Wiring IDE. The main entry
+ point is in IDE/processing/app/Base.java.
+
+* framework/: Contains the Wiring Framework, associated libraries, and
+ its implementations. These implementations (called "cores") contain
+ the nonportable code which targets a concrete microcontroller (or
+ family of microcontrollers).
+
+* build: Files used when building the Wiring IDE.
+
+* out/: [generated] This directory is autogenerated during the build
+ process. It contains all of the build artifacts. After a build, this
+ directory includes any downloaded dependencies, Java class and jar
+ files, and the distributable IDE bundles.

No commit comments for this range

Something went wrong with that request. Please try again.