diff --git a/tutorial/README.md b/tutorial/README.md index 86d56bf..84eeaf4 100644 --- a/tutorial/README.md +++ b/tutorial/README.md @@ -1,7 +1,7 @@ Intro to MR4C Examples: =========== -###EXAMPLES +### EXAMPLES 1. hello world - set up a basic working algorithm 2. input output - learn how to read and write datasets @@ -13,7 +13,7 @@ Intro to MR4C Examples: 8. mbtiles - an example using the MR4C Geospatial library to export a mbtiles file from a Skysat scene. 9. random access - when you need to deal with large datasets, you will need to read in smaller chunks. This example shows you the various ways that MR4C can help you do this. -###Run in Hadoop +### Run in Hadoop * HDFS commands - use the format: diff --git a/tutorial/example1_HelloWorld/README.md b/tutorial/example1_HelloWorld/README.md index bf8bc9c..80c522a 100644 --- a/tutorial/example1_HelloWorld/README.md +++ b/tutorial/example1_HelloWorld/README.md @@ -1,19 +1,19 @@ -#MR4C "Hello World" Application +# MR4C "Hello World" Application Hello World application for MR4C -##Description +## Description This is the classic "HelloWorld" application that should verify that your build is working correctly. -##Installation +## Installation Navigate to the HelloWorld folder and make the project using the folowing commands: cd ~/MR4C/examples/example1_HelloWorld make -##Run Hello World +## Run Hello World To run our hello world application: @@ -21,24 +21,24 @@ To run our hello world application: This should print out "Hello World" in a block labled "**NATIVE_OUTPUT**" to separate it from the mr4c messages. -##Concepts +## Concepts To fully understand how a basic MR4C application works, review the following files in your installation folder. -###/src/helloworld.cpp +### /src/helloworld.cpp defines the Example class that executes an algorithm (cout<<"hello world"<skip(buffersize); } -###Random Access +### Random Access If you need to use a variable size buffer and read and write to any part of a file then you will need to instantiate a RandomAccessFile object and use the similar member functions. In the example, we read an input dataset and iterate through the dataset keys and instantiate a RandomAccessFile object for each file. We then read some random blocks into a 100 byte buffer and print them to stdout. Finally, we create some output files and write some of the content that we extracted from the input files as well as some modified content to arbitrary locations within a 1000 byte file. Input and output datasets are stored in HDFS, please refer to the RandomAccess.json and RandomAccess.sh files to understand the staging process. -###Execution Example +### Execution Example To execute: ./RandomAccess.sh