A standard C library designed for Magenta
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Photon is a standard C library for Magenta-based systems. Photon is designed to abstract different Magenta-specific designs, such as handles and IPC-based file operations, into a standard interface compatible with regular C programs.

Getting Started

To build photon, follow these steps.

Prerequisites

There's some software you'll need to install before you can compile photon.

• CMake 3.5

Usage

With GCC, a program can be compiled with -ffreestanding -nostdlib to disable linking to the system's C runtime. From there, you can link with photon to use it as your C library instead.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

If you feel like contributing to this project, here's how to do so.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the BSD 3-Clause License. See LICENSE for more information.

Contact

Max Wash - @waash - max@doorstuck.net

Project Link: https://gitlab.com/doorstuck/magenta/photon.git