/usr/share/eliom/destillery/basic/README is in eliom 3.0.3-4build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | Instructions
============
This project is (initially) generated by eliom-destillery as the basic
project "%%%PROJECT_NAME%%%".
Generally, you can compile it and run ocsigenserver on it by
$ make test.byte (or test.opt)
See below for other useful targets for make.
Generated files
---------------
The following files in this directory have been generated by
eliom-destillery:
- %%%PROJECT_NAME%%%.eliom
This is your initial source file.
%%%ifdef OCAML4%%%
All Eliom files (*.eliom, *.eliomi) in this directory are
automatically considered. To add a .ml/.mli file to your project,
append it to the variable SERVER_FILES or CLIENT_FILES.
%%%endif%%%
%%%ifdef OCAML3%%%
To add more source files (.ml,.mli,.eliom,.eliomi) to your project,
add it to the variables SERVER_FILES and/or CLIENT_FILES.
%%%endif%%%
- static/
The content of this folder is statically served. Put your CSS or
additional JavaScript files here!
- Makefile.options
Configure your project here!
- %%%PROJECT_NAME%%%.conf.in
This file is a template for the configuration file for
ocsigenserver. You will rarely have to edit itself - it takes its
variables from the Makefile.options. This way, the installation
rules and the configuration files are synchronized with respect to
the different folders.
- Makefile
This contains all rules necessary to build, test, and run your
Eliom application. You better don't touch it ;) See below for the
relevant targets.
- README
Not completely describable here.
Makefile targets
----------------
Here's some help on how to work with this basic destillery project:
- Test your application by compiling it and running ocsigenserver locally
$ make test.byte (or test.opt)
- Compile it only
$ make all (or byte or opt)
- Deploy your project on your system
$ sudo make install (or install.byte or install.opt)
- Run the server on the deployed project
$ sudo make run.byte (or run.opt)
If WWWUSER in the Makefile.options is you, you don't need the
`sudo'. If Eliom isn't installed globally, however, you need to
re-export some environment variables to make this work:
$ sudo PATH=$PATH OCAMLPATH=$OCAMLPATH LD_LIBRARY_PATH=$LD_LIBRARY_PATH make run.byte/run.opt
- If you need a findlib package in your project, add it to the
variables SERVER_PACKAGES and/or CLIENT_PACKAGES. The configuration
file will be automatically updated.
|