diff --git a/Readme b/Readme deleted file mode 100644 index 1b5b38f..0000000 --- a/Readme +++ /dev/null @@ -1,27 +0,0 @@ - - Elib1 - - An Erlang library and collection of applications - -You will also have to do the following: - - 1) add a path to your ${HOME}/.erlang - code:add_patha(".../elib1-3/lib/ebin"). - - 2) add path to your .bash_profile (on a mac) - export PATH=/Users/joe/code/elib2-1/bin:$PATH - - 3) make eindex and executable - chmod u+x elib1-3/bin/einidex - chnod u+x elib1-3/bin/elib2_find_similar_files - -Then make to compile the library and view -the documentation. - -This should start a web server on port - -If it doesn't point your browser at: - - http://localhost:2246/supported/website/index.ehtml - -Note - I have only tested this with firefox diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..afbfe9d --- /dev/null +++ b/Readme.md @@ -0,0 +1,31 @@ +Elib1 +=== + +An Erlang library and collection of applications + +You will also have to do the following: + +1. add a path to your `${HOME}/.erlang` +```erlang +code:add_patha(".../elib1-3/lib/ebin"). +``` + +2. add path to your .bash_profile (on a mac) +```shell +export PATH=/Users/joe/code/elib2-1/bin:$PATH +``` + +3. make eindex and executable +```shell +chmod u+x elib1-3/bin/einidex +chnod u+x elib1-3/bin/elib2_find_similar_files +``` + +Then make to compile the library and view +the documentation. + +This should start a web server on port + +If it doesn't point your browser to http://localhost:2246/supported/website/index.ehtml + +Note - I have only tested this with firefox