Rz-Rz / fdf

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

FdF is the wireframe representation of 3D field or object. It allows the representation of existing or imaginary objects, such as a map of Mars or a field generated by a mathematical fractal. The lines can be coloured to match the actual height of the 3D object, enhancing the representation by giving visual cues.

(back to top)

Built With

• [![minilibx-linux][https://github.com/42Paris/minilibx-linux]][JQuery-url]

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

MiniLibX for Linux requires xorg, x11 and zlib, therefore you will need to install the following dependencies: xorg, libxext-dev and zlib1g-dev. Installing these dependencies on Ubuntu can be done as follows:

• npm

  sudo apt-get update && sudo apt-get install xorg libxext-dev zlib1g-dev libbsd-dev

Installation

1. Clone the repo

   git clone https://github.com/Rz-Rz/fdf.git

2. Run make

make

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

   $>./fdf 42.fdf

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @@DhrifKarim - [e-mail]

Project Link: https://github.com/Rz-Rz/fdf

(back to top)

Acknowledgments

(back to top)