File: README.dev

package info (click to toggle)
xylib 1.6-3.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,120 kB
  • sloc: cpp: 5,828; sh: 4,355; python: 47; makefile: 46
file content (32 lines) | stat: -rw-r--r-- 1,009 bytes parent folder | download | duplicates (3)
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

HOW TO ADD A NEW FORMAT
=======================

Each .cpp/.h file pair in xylib/ (excluding xylib.*, cache.* and util.*)
corresponds to one supported filetype.

To add new filetype foo:

-  go to xylib/ subdirectory
-  write foo.cpp and foo.h files (or copy and modify existing files) 
-  in foo.h write what your implementation is based on,
   i.e., what documentation is available to you.
-  #include foo.h in xylib.cpp
-  add an entry to formats[] array in xylib.cpp (but not after TextDataSet)
-  add foo.cpp and foo.h files to xylib/Makefile.am
-  add xylib/foo.cpp to CMakeLists.txt

Do not worry too much about metadata, especially if the file is human-readable.
Currently programs that use xylib mostly ignore metadata.

You may contact us before you start, to avoid duplication of work.


METADATA CONVENTIONS
====================

Naming conventions are introduced and documented here when programs using
this library start relying on it.

"source energy" (block) - energy of photons used in XPS