Leo f8799b6d0f Correct typo in tips il y a 9 ans
..
test 29aa9857ea Change my contact address il y a 9 ans
third-part 508e38116f Add copyright notice for Core_kernel copied files il y a 9 ans
.merlin f9883977cb Update merlin il y a 10 ans
README.md d9b39203b3 Add general explanation of the way the program works il y a 9 ans
add_command.ml 29aa9857ea Change my contact address il y a 9 ans
clean_command.ml 29aa9857ea Change my contact address il y a 9 ans
color_print.ml 279289f7e6 Restore the color part of Core_extended il y a 9 ans
command_def.ml 29aa9857ea Change my contact address il y a 9 ans
const.ml 29aa9857ea Change my contact address il y a 9 ans
const.mli 29aa9857ea Change my contact address il y a 9 ans
default.ml 29aa9857ea Change my contact address il y a 9 ans
edit_command.ml 29aa9857ea Change my contact address il y a 9 ans
exec_cmd.ml 29aa9857ea Change my contact address il y a 9 ans
file_com.ml f8799b6d0f Correct typo in tips il y a 9 ans
licencing.ml 29aa9857ea Change my contact address il y a 9 ans
list_rc.ml 29aa9857ea Change my contact address il y a 9 ans
lock.ml 29aa9857ea Change my contact address il y a 9 ans
lock.mli 29aa9857ea Change my contact address il y a 9 ans
messages.ml 29aa9857ea Change my contact address il y a 9 ans
messages.mli 29aa9857ea Change my contact address il y a 9 ans
oclaunch.ml 29aa9857ea Change my contact address il y a 9 ans
remove_command.ml 29aa9857ea Change my contact address il y a 9 ans
settings.atd 29aa9857ea Change my contact address il y a 9 ans
settings_j.ml 527d3e3b7f Correct .gitignore il y a 10 ans
settings_j.mli 527d3e3b7f Correct .gitignore il y a 10 ans
settings_t.ml 527d3e3b7f Correct .gitignore il y a 10 ans
settings_t.mli 527d3e3b7f Correct .gitignore il y a 10 ans
settings_v.ml 527d3e3b7f Correct .gitignore il y a 10 ans
settings_v.mli 527d3e3b7f Correct .gitignore il y a 10 ans
signals.ml 29aa9857ea Change my contact address il y a 9 ans
signals.mli 29aa9857ea Change my contact address il y a 9 ans
src_org.svg 09268679c1 Add source explanation, to help contributors il y a 9 ans
state.ml 29aa9857ea Change my contact address il y a 9 ans
tmp_biniou.atd 29aa9857ea Change my contact address il y a 9 ans
tmp_biniou_b.ml 5e0c32c7af Allow to use multiple tmp files il y a 9 ans
tmp_biniou_b.mli 5e0c32c7af Allow to use multiple tmp files il y a 9 ans
tmp_biniou_t.ml 5e0c32c7af Allow to use multiple tmp files il y a 9 ans
tmp_biniou_t.mli 5e0c32c7af Allow to use multiple tmp files il y a 9 ans
tmp_biniou_v.ml 5e0c32c7af Allow to use multiple tmp files il y a 9 ans
tmp_biniou_v.mli 5e0c32c7af Allow to use multiple tmp files il y a 9 ans
tmp_file.ml 29aa9857ea Change my contact address il y a 9 ans
tmp_file.mli 29aa9857ea Change my contact address il y a 9 ans
tools.ml 29aa9857ea Change my contact address il y a 9 ans
tools.mli 29aa9857ea Change my contact address il y a 9 ans
unify.ml 29aa9857ea Change my contact address il y a 9 ans
unify.mli 29aa9857ea Change my contact address il y a 9 ans

README.md

Source organisation

Where to start

In order of execution, the first file to be read is oclaunch.ml. From this is called command line argument parsing (in command_def.ml). Then, all is organised in modules, i.e. one file grouping functions used for a given functionality.

Source organisation scheme

General work

The general idea is that we read the rc file, adapt it to tmp file and do what the user asked. It can be an editing on the rc file or a launching of the next command.

To Infinity and Beyond

To find your way in modules, read comments explaining the goal of it.
It's at the start of the file, just after the licence header.