Skip to content

Commit 2a787dc

Browse files
committed
Added some text files describing the directory organization.
1 parent 77335c5 commit 2a787dc

File tree

3 files changed

+33
-8
lines changed

3 files changed

+33
-8
lines changed

changelogs/readme.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
The files in this directory contain the change logs. For the 3.0.0 release, which has
2+
a huge change log, we keep two separate files. These files are identical to the ones
3+
at https://diplib.org/changelogs/
4+
5+
As you commit things to the master branch, add relevant notes to the latest change
6+
log file, so that it is easy to create a release.

repository_organization.txt

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Here we describe the organization of the repository, which is getting
2+
increasingly complex and large.
3+
4+
changelogs/ This is where the change logs are stored.
5+
6+
dependencies/ External code needed for building the DIPlib project,
7+
but not necessary to compile code that uses DIPlib.
8+
9+
dipimage/ Sources for DIPimage, the MATLAB toolbox.
10+
11+
doc/ Additional DIPlib documentation in the form of Markdown files,
12+
and other files needed by the documentation build system.
13+
14+
examples/ Example source code in C++ and Python.
15+
16+
include/ All the C++ public header files.
17+
18+
javaio/ The DIPjavaio module (BioFormats interface) C++ and Java source code.
19+
20+
pydip/ The PyDIP (Python bindings) C++ and Python source code.
21+
22+
src/ The DIPlib C++ source code.
23+
24+
tools/ Assorted scripts needed for building the DIPlib project.
25+
26+
viewer/ The DIPviewer module C++ source code

src/readme.txt

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ detection/ Feature detection (diplib/detection.h)
77
display/ Preparing images for display (diplib/display.h)
88
distance/ Distance transforms (diplib/distance.h)
99
file_io/ Image file I/O (diplib/file_io.h)
10-
linear/ Linear filters (diplib/linear.h)
1110
geometry/ Interpolation and geometric transformations (diplib/geometry.h)
1211
generation/ Creating image data (diplib/generation.h)
1312
histogram/ Histograms (diplib/histogram.h, diplib/distribution.h)
1413
library/ Core library functionality (diplib/library/*.h, diplib/boundary.h, diplib/framework.h,
1514
diplib/kernel.h, diplib/neighborlist.h, diplib/pixel_table.h)
15+
linear/ Linear filters (diplib/linear.h)
1616
mapping/ Grey-value mapping (diplib/lookup_table.h, diplib/mapping.h)
1717
math/ Pixel math (diplib/math.h, diplib/statistics.h)
1818
measurement/ Measurement infrastructure and functions (diplib/measurement.h, diplib/chain_code.h)
@@ -23,10 +23,3 @@ regions/ Labeling and labeled image processing (diplib/regions.h)
2323
segmentation/ Segmentation (diplib/segmentation.h)
2424
support/ Functions that don't work on images (diplib/library/numeric.h)
2525
transform/ Fourier and related transforms (diplib/transform.h, diplib/dft.h)
26-
27-
../dependencies/* External code needed for compilation of DIPlib and/or components,
28-
but not necessary to compile code that uses DIPlib.
29-
30-
../include/ All the public header files
31-
32-
../doc/src/ Additional DIPlib documentation in the form of Markdown files

0 commit comments

Comments
 (0)