Initial commit

README.md

@@ -0,0 +1,88 @@
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
+<br />
+<div align="center">
+  <a href="https://gitlab.com/doorstuck/magenta/photon.git">
+    <img src="doc/logo.png" alt="Logo" width="200">
+  </a>
+
+
+  <p align="center">
+    A standard C library designed for Magenta
+    <br />
+    <a href="https://gitlab.com/doorstuck/magenta/photon/wikis/home"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://gitlab.com/doorstuck/magenta/photon/issues">Report Bug</a>
+    ·
+    <a href="https://gitlab.com/doorstuck/magenta/photon/issues">Request Feature</a>
+  </p>
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+
+* [About the Project](#about-the-project)
+* [Getting Started](#getting-started)
+  * [Prerequisites](#prerequisites)
+  * [Installation](#installation)
+* [Usage](#usage)
+* [Roadmap](#roadmap)
+* [Contributing](#contributing)
+* [License](#license)
+* [Contact](#contact)
+
+<!-- ABOUT THE PROJECT -->
+## 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 -->
+## 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 EXAMPLES -->
+## 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 -->
+## Roadmap
+
+See the [open issues](https://gitlab.com/doorstuck/magenta/photon/issues) for a list of proposed features (and known issues).
+
+
+<!-- CONTRIBUTING -->
+## 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 -->
+## License
+
+Distributed under the BSD 3-Clause License. See `LICENSE` for more information.
+
+
+<!-- CONTACT -->
+## Contact
+
+Max Wash - [@waash](https://gitlab.com/waash) - max@doorstuck.net
+
+Project Link: [https://gitlab.com/doorstuck/magenta/photon.git]()
+