User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
cs:getting_started:start [2022/04/15 01:46]
Chris Nathman [Getting our Code]
cs:getting_started:start [2022/04/15 02:10]
Chris Nathman [Languages]
Line 10: Line 10:
  
 ===== Languages ===== ===== Languages =====
-We use primarily ​C++ and Python3 for the software on the sub. Below are a few links for tutorials for these languages, these are just a few I quickly found to get you started, feel free to search around for other tutorials.+We use C++ and Python3 for the software on the sub. Below are a few links for tutorials for these languages, these are just a few I quickly found to get you started, feel free to search around for other tutorials.
   * [[http://​www.learncpp.com/​| C++]]   * [[http://​www.learncpp.com/​| C++]]
   * [[https://​www.codecademy.com/​learn/​python|Python]]   * [[https://​www.codecademy.com/​learn/​python|Python]]
Line 63: Line 63:
  
 Create a directory for robosub code and move into it. Create a directory for robosub code and move into it.
 +
 <code bash> <code bash>
 $ mkdir -p ~/ros/src $ mkdir -p ~/ros/src
Line 68: Line 69:
 </​code>​ </​code>​
  
-Clone essential robosub repositories.+Clone essential robosub repositories. ​Note that here we clone using https. If you setup ssh keys than you should clone using ssh instead. Replace the ''<​nowiki>​https://​gitlab.com/</​nowiki>''​ parts of the links below with ''​git@gitlab.com:''​ to clone with ssh. 
 <code bash> <code bash>
 $ git clone https://​gitlab.com/​PalouseRobosub/​Software/​robosub.git $ git clone https://​gitlab.com/​PalouseRobosub/​Software/​robosub.git
Line 74: Line 76:
 $ git clone https://​gitlab.com/​PalouseRobosub/​Software/​robosub_simulator.git $ git clone https://​gitlab.com/​PalouseRobosub/​Software/​robosub_simulator.git
 </​code>​ </​code>​
-  ​cd ~/ros + 
-  colcon build +Move back to the ros directory. 
-  echo "​source ~/​ros/​install/​setup.bash"​ >> ~/.bashrc + 
-  echo 'alias rsmake="​(cd ~/ros && colcon build)"'​ >> ~/.bashrc +<code bash> 
-  source ~/.bashrc+cd ~/ros 
 +</​code>​ 
 +  ​ 
 +Compile the code for the first time. This will take some time since it has to compile a lot of code. Future compilation should be much faster since the build system will know what it has already compiled. 
 + 
 +<code bash> 
 +colcon build 
 +</​code>​ 
 + 
 +Add compiled code configuration to bash configuration file. 
 + 
 +<code bash> 
 +echo "​source ~/​ros/​install/​setup.bash"​ >> ~/.bashrc 
 +</​code>​ 
 + 
 +Add ''​rsmake''​ alias to bash configuration file so future compilation can be run easily. 
 + 
 +<code bash> 
 +echo 'alias rsmake="​(cd ~/ros && colcon build)"'​ >> ~/.bashrc 
 +</​code>​ 
 + 
 +Reload bash configuration file. 
 + 
 +<code bash> 
 +source ~/.bashrc 
 +</​code>​
  
 From now on you should be able to compile code using ''​rsmake''​ from any directory. From now on you should be able to compile code using ''​rsmake''​ from any directory.