Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 2.11 KB

README.md

File metadata and controls

43 lines (24 loc) · 2.11 KB

EpilogLite Source Repository

This repository contains the complete source code for the EpilogLite database engine, including test scripts.

See the on-line documentation for more information about what EpilogLite is and how it works from a user's perspective. This README.md file is about the source code that goes into building EpilogLite, not about how EpilogLite is used.

Version Control

EpilogLite sources are managed using GitHub.

Contacting The EpilogLite Developers

Bug reports, enhancement requests, and documentation suggestions can be opened at the Epilogue Issues list.

The preferred way to ask questions or make comments about EpilogLite is to visit the EpilogLite Discussions.

Private security vulnerability reporting is enabled on this repository.

GNU LESSER GENERAL PUBLIC LICENSE

The EpilogLite source code is released under the GNU Lesser General Public License 3.0 only. See LICENSE.md for details.

Testing and Compiling

Since this is a Rust application, the normal 'cargo' commands can be used to test or build the application.

To execute the test suite run:

cargo test

To create a release build run:

cargo build --release

The compiled binaries will be in the 'target' folder after the build completes.

How It All Fits Together

EpilogLite is modular in design. See the architectural description for details. Other documents that are useful in helping to understand how EpilogLite works include the file format description, the virtual machine that runs prepared statements, the description of how transactions work, and the overview of the query planner.