Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 870 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (24 loc) · 870 Bytes

Contributing to Bob

Compiling Bob

You'll need -

  1. g++ - run apt install g++ for Ubuntu based Linux distros.
  2. rust - https://www.rust-lang.org/tools/install.
  3. Run

    	cargo build 
    

    Compiling a bob script

    	cargo run name_of_bob_file.bob
    

    Important tips

    1. Docs may be built and opened on your browser with - cargo doc --open
    2. Comment out the last statementi - fs::remove_file("output.cpp").expect("Bob couldn't delete his temporary file"); from main.rs to be able to see the output.cpp file generated. This may be used for debugging.
    3. Run time errors must always be avoided, and unavoidable errors included in the Errors enum in lib.rs, and managed by the raise function. For example, refer the implementaion in C++ of the read function, where the data type of the input is verified.