Skip to content

Commit

Permalink
updated Make files for doc quick starter guide
Browse files Browse the repository at this point in the history
  • Loading branch information
sethuchandan committed Sep 7, 2012
1 parent 978749b commit 8679f64
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 11 deletions.
Empty file added .nojekyll
Empty file.
7 changes: 3 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Key Features
Required Tools
==============

11.11.0 and above
11.11.1 and above


Support
Expand Down Expand Up @@ -50,7 +50,7 @@ The repository explains about the compatability of slice kit core board with GPI
Documentation
=============

Quick starter guilde for the applications are avilable in the applciations seperately.
Quick starter guilde for the applications are avilable for each application seperately in the applciation "doc_quickstart" folder seperately.


Known Issues
Expand All @@ -61,8 +61,7 @@ Known Issues
Support
=======

This package is supported by XMOS Ltd. Issues can be raised against the software
at:
This package is supported by XMOS Ltd. Issues can be raised against the software at:

http://www.xmos.com/support

Binary file not shown.
13 changes: 10 additions & 3 deletions app_slicekit_com_demo/doc_quickstart/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
sw_gpio_examples COM demo : Quick Start Guide
--------------------------------------------------

We use the XA-SK-GPIO GPIO Slice Card together with the xSOFTip UART software to create a UART , and send data to and from a PC COM port and also xSOFTip I2C software component to communicate with on board ADC. This application showcases some of the software key features and serves as an example on how to use APIs of UART and I2C. This demo features UART data loop back, receives commands from comport, and perform according to the command input.
We use the XA-SK-GPIO GPIO Slice Card together with the xSOFTip UART software to create a UART , and send data to and from a PC COM port.
Also xSOFTip I2C software component to communicate with on board ADC.
This application showcases some of the software key features and serves as an example on how to use APIs of UART and I2C.
This demo features UART data loop back, receives commands from comport, and perform according to the command input.

Software Configuration
++++++++++++++++++++++

The following defines should be made according to the connection of the GPIO slice acard to the core board:
The following defines should be made according to the connection of the
GPIO slice acard to the core board:

* #define SK_GPIO_SLOT_SQUARE - connect the GPIO slice card to the SLOT SQUARE of core baoard.
* #define SK_GPIO_SLOT_CIRCLE - connect the GPIO slice card to the SLOT CIRCLE of core baoard.
* #define SK_GPIO_SLOT_TRIANGLE - connect the GPIO slice card to the TRIANGLE of core baoard.
Expand All @@ -18,6 +23,7 @@ Build the Application
+++++++++++++++++++++

The following components are required to build ``app_slicekit_com_demo`` application:

* sc_i2c: https://github.com/xcore/sc_i2c.git
* sc_uart: https://github.com/xcore/sc_uart.git
* xcommon: https://github.com/xcore/xcommon.git (Optional)
Expand All @@ -39,7 +45,8 @@ The following tools should be installed on the host system in order to run this
http://www.hw-group.com/products/hercules/index_en.html
* For MAC users: SecureCRT7.0
http://www.vandyke.com/download/securecrt/


#. Note: Make sure to change the settings of the tool as Windows style line end characters.

Set Up The Hardare
++++++++++++++++++
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
all: html

SPHINX_PROJECT_NAME = SIMPLE GPIO Demo Quickstart Guide
SPHINX_PROJECT_NAME = GPIO SIMPLE Demo Quickstart Guide
VERSION = 0.1
SOURCE_INCLUDE_DIRS = ../app_slicekit_simple_demo
XDOC_DIR ?= ../../../xdoc
Expand Down
Binary file not shown.
13 changes: 10 additions & 3 deletions app_slicekit_simple_demo/doc_quickstart/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
sw_gpio_examples simple demo : Quick Start Guide
--------------------------------------------------

We use the XA-SK-GPIO GPIO Slice Card together with the I2C software component to communicate with on board ADC. This application showcases some of the software key features and serves as an example on how to use API of I2C. This demo features cycles on baord LEDs by Button press and displays current temperature value on Button press.
We use the XA-SK-GPIO GPIO Slice Card together with the I2C software component to communicate with on board ADC.
This application showcases some of the software key features and serves as an example on how to use API of I2C.
This demo features cycles on baord LEDs by Button press and displays current temperature value on Button press.

Software Configuration
++++++++++++++++++++++

The following defines should be made according to the connection of the GPIO slice acard to the core board:
The following defines should be made according to the connection of the
GPIO slice acard to the core board:

* #define SK_GPIO_SLOT_SQUARE - connect the GPIO slice card to the SLOT SQUARE of core baoard.
* #define SK_GPIO_SLOT_CIRCLE - connect the GPIO slice card to the SLOT CIRCLE of core baoard.
* #define SK_GPIO_SLOT_TRIANGLE - connect the GPIO slice card to the TRIANGLE of core baoard.
Expand All @@ -18,6 +22,7 @@ Build the Application
+++++++++++++++++++++

The following components are required to build ``app_slicekit_simple_demo`` application:

* sc_i2c: https://github.com/xcore/sc_i2c.git
* xcommon: https://github.com/xcore/xcommon.git (Optional)

Expand All @@ -39,7 +44,9 @@ Set Up The Hardare

Demonstration Hardware Setup

#. Connect XA-SK-GPIO Slice Card to the XP-SKC-L2 Slicekit Core board. This Slice Card can be connected to either ``Square``, ``Tringle`` or ``Star`` connector of Slicekit Core board, but for now, use the TRIANGLE slot as shown in the figure above
#. Connect XA-SK-GPIO Slice Card to the XP-SKC-L2 Slicekit Core board.
This Slice Card can be connected to either ``Square``, ``Tringle`` or ``Star`` connector of Slicekit Core board,
but for now, use the TRIANGLE slot as shown in the figure above
#. Connect the XTAG Adapter to Slicekit Core board, Chain connector and connect XTAG-2 to the adapter.
#. Connect the XTAG-2 to host PC or Mac USB port.
#. Switch on the power supply to the Slicekit Core board.
Expand Down

0 comments on commit 8679f64

Please sign in to comment.