Skip to content
This repository has been archived by the owner on Aug 28, 2019. It is now read-only.

Commit

Permalink
Update README.txt
Browse files Browse the repository at this point in the history
Added more specific instructions on how to import our libraries
  • Loading branch information
marict committed May 9, 2017
1 parent bc0b100 commit 1966568
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.txt
Expand Up @@ -6,18 +6,21 @@ To get started, fork and clone the repository:
https://github.com/elcano/elcano

Parameters and settings for each trike are defined in:
arduino/libraries/Settings/Settings.h
/libraries/Settings/Settings.h

Place the contents of the libraries folder into your libraries folder under
Arduino/libraries

The repository includes examples in the file:
arduino/libraries/Settings/SettingsTemplate.h
Arduino/libraries/Settings/SettingsTemplate.h

Only libraries/Settings/SettingsTemplate.h should be committed in the
repository -- the arduino/libraries/Settings/Settings.h file is site-specific.
repository -- the Arduino/libraries/Settings/Settings.h file is site-specific.

-- Copy
arduino/libraries/Settings/SettingsTemplate.h
Arduino/libraries/Settings/SettingsTemplate.h
to
arduino/libraries/Settings/Settings.h
Arduino/libraries/Settings/Settings.h
-- Give your trike a different VEHICLE_NUMBER value.
-- Add your own trike's settings, following the examples.
-- Put your settings in a conditional for your new VEHICLE_NUMBER value.
Expand All @@ -28,4 +31,4 @@ Especially watch for new trike parameters used in sketches.

Sketches that need these settings should
#include <Settings.h>
*after* all other includes or definitions that are used in Settings.h.
*after* all other includes or definitions that are used in Settings.h.

0 comments on commit 1966568

Please sign in to comment.