summaryrefslogtreecommitdiff
path: root/documentation/directory_structure.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/directory_structure.mdwn')
-rw-r--r--documentation/directory_structure.mdwn45
1 files changed, 45 insertions, 0 deletions
diff --git a/documentation/directory_structure.mdwn b/documentation/directory_structure.mdwn
new file mode 100644
index 0000000..e9d00a7
--- /dev/null
+++ b/documentation/directory_structure.mdwn
@@ -0,0 +1,45 @@
+[[!meta title="Documentation/Directory Structure"]]
+[[!meta author="Tlsa"]]
+[[!meta date="2012-10-23T10:53:54Z"]]
+
+
+[[!toc]] NetSurf's code is broadly
+split into two; core code, and front end code. All ports make use of the
+core code and each port has its own front end code.
+
+Directory Structure
+-------------------
+
+The source is split at top level as follows:
+
+### Core
+
+#### Content handling
+
+- **content** -- Generic content handling: Fetching, caching,
+ managing, etc
+- **css** -- CSS content specific handling
+- **image** -- Image content specific handling (conversion)
+- **javascript** -- JavaScript content specific handling
+- **render** -- HTML and Text content specific handling (processing,
+ layout, render)
+
+#### Other core components
+
+- **desktop** -- Non-platform specific front-end
+- **utils** -- Misc reusable components
+
+### Front ends
+
+- **amiga** -- AmigaOS specific code
+- **atari** -- Atari FreeMiNT code
+- **beos** -- BeOS/Haiku specific code
+- **cocoa** -- Mac OS X specific code
+- **framebuffer** -- Framebuffer specific code
+- **gtk** -- GTK specific code
+- **monkey** -- Terminal based test engine specific code
+- **riscos** -- RISC OS specific code
+- **windows** -- Windows specific code
+
+[[!inline raw=yes pages="Documentation"]]
+