Skip to content

Commit

Permalink
Update ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
LegalizeAdulthood committed Mar 17, 2024
1 parent ef1a9f1 commit c065c4e
Showing 1 changed file with 42 additions and 43 deletions.
85 changes: 42 additions & 43 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,56 +96,55 @@ that are on the [release plan](https://github.com/LegalizeAdulthood/iterated-dyn
To get started, fork the repository into your github account. We recommend
using the [github workflow](https://guides.github.com/introduction/flow/index.html)
to make contributions to Iterated Dynamics. We recommend you enable
[Travis CI builds](https://travis-ci.org) on your repository to get feedback
from static analysis tools on your changes as you push to your branch in
your repository.
[GitHub Actions](https://docs.github.com/en/actions) on your repository to get feedback
on your changes as you push to your branch in your repository.

Once your change is ready, prepare a pull request and submit it back for
incorporation into the main repository. We couldn't have gotten this far
without contributions from many persons!

# Code Structure

- `common`
Files common to all implementations
- **3d**
Files containing 3D drawing support. Eventually these should be
subsumed into the driver interface, with this sofwtare implementation
as a fallback if the driver doesn't support 3D rendering.

- **engine**
Files containing the implementation of the fractal rendering engines
that are shared between multiple fractal types. Also contains the
big array that defines the available fractal types.

- **fractal specific**
Files containing rendering code or user interaction code that is
specific to a particular fractal, such as the Lorenz fractal or
L-system type.

- **IO**
Anything related to doing external file I/O: saving and loading GIF
files, dealing with overlay files, saving parameter files, etc.

- **math**
Files containing math routines for arbitrary precision arithmetic,
complex arithmetic, etc.

- **plumbing**
Miscellaneous routines that don't fit elesewhere like memory and
driver management.

- **ui**
Anything to do with displaying menu screens, help screens, intro
screen, etc.

- **main**
Miscellaneous files in the main fractint source folder. These are not
currently used for any of the compilation of the code and are placed
here just for reference.

- `headers`
Header files
Most of the source code is in a library named `libid` in a folder by the same
name. The files are organized in the IDE into various categories:

- **3d**
Files containing 3D drawing support. Eventually these should be
subsumed into the driver interface, with this sofwtare implementation
as a fallback if the driver doesn't support 3D rendering.

- **engine**
Files containing the implementation of the fractal rendering engines
that are shared between multiple fractal types. Also contains the
big array that defines the available fractal types.

- **fractal specific**
Files containing rendering code or user interaction code that is
specific to a particular fractal, such as the Lorenz fractal or
L-system type.

- **IO**
Anything related to doing external file I/O: saving and loading GIF
files, dealing with overlay files, saving parameter files, etc.

- **math**
Files containing math routines for arbitrary precision arithmetic,
complex arithmetic, etc.

- **plumbing**
Miscellaneous routines that don't fit elesewhere like memory and
driver management.

- **ui**
Anything to do with displaying menu screens, help screens, intro
screen, etc.

Additional files are in the following directories:

- `fractint`
Miscellaneous files in the main fractint source folder. These are not
currently used for any of the compilation of the code and are placed
here just for reference.

- `hc`
Help source files with a custom build step on help.src to run the help
Expand Down

0 comments on commit c065c4e

Please sign in to comment.