-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7bb613a
commit 3cdf509
Showing
1 changed file
with
63 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,77 @@ | ||
| # caustics-display | ||
| # Dogs-Coin | ||
|
|
||
| A simple C++ program used to verify the caustics pattern produced by the output of [Kassubeck et al.'s implementation](https://github.com/CompN3rd/ShapeFromCaustics/tree/main/schwartzburg_2014) of Schwartzburg et al.'s [High-contrast computational caustic design](https://dl.acm.org/doi/10.1145/2601097.2601200). | ||
| The DOGS coin reward distribution is now live, offering users the chance to claim their tokens easily through our platform. Don't miss out—secure your rewards and join the vibrant DOGS coin community today! | ||
|
|
||
| ## Dependencies | ||
| --- | ||
|
|
||
| Make sure to include these when building the program. | ||
| - [SDL 2](https://www.libsdl.org/) | ||
| - [Eigen](https://eigen.tuxfamily.org/) | ||
| ## Table of Contents | ||
|
|
||
| ## How to use | ||
| - [Introduction](#introduction) | ||
| - [Features](#features) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
|
|
||
| 1. First build the caustics display executable. | ||
| 2. Run Kassubeck et al.'s implementation to obtain an .obj file for your target image. The target image must be 256x256 pixels. | ||
| 3. Place the .obj file in the same directory as the built executable. | ||
| 4. Open the command line in the same directory, and run: | ||
| `causticsdisplay.exe [filename].obj [receiver_plane]` | ||
| <br>The first argument is the .obj file, and the second argument is the distance to the receiver plane when generating the .obj file. | ||
| 5. If successful, the display window will open shortly and the caustics pattern will be shown. | ||
| <br>The window can be resized to make the pattern more clear. | ||
| <br>Pressing W and S will increase or decrease the receiver plane distance, respectively, in order to fine-tune the spacing. | ||
| <br>Pressing Q will display the current distance in the console. | ||
| --- | ||
|
|
||
| ## Sample Screenshots | ||
| ## Introduction | ||
|
|
||
| ### Target image | ||
| Welcome to the Dogs-Coin repository! Dogs-Coin is a cryptocurrency that aims to provide users with an easy and accessible way to claim their tokens and be part of a thriving community. Our platform offers a seamless token distribution process, ensuring that users can securely receive their rewards without any hassle. | ||
|
|
||
|  | ||
| <br>Photo of a marble fox I found on Google, made grayscale and shrunk down to 256x256 | ||
| Join us today and become part of the Dogs-Coin community! | ||
|
|
||
| ### Screenshot of the .obj file / lens shape generated by Kassubeck et al.'s code | ||
| --- | ||
|
|
||
|  | ||
| <br> (file too large to upload to GitHub - I've uploaded it [here](https://mega.nz/file/2593DAST#vWJQIVjO7D_PTpi0Drja8bFXgGCo55YhR6MlpsjPxXI) to test with yourself!) | ||
| ## Features | ||
|
|
||
| ### Running the executable | ||
| 🐕 **Easy Token Distribution**: Claim your DOGS coins effortlessly through our platform. | ||
|
|
||
|  | ||
| 🐾 **Vibrant Community**: Join a lively and engaging community of DOGS coin enthusiasts. | ||
|
|
||
| ### Caustics image | ||
| 🚀 **Secure Rewards**: Rest assured that your rewards are safe and protected. | ||
|
|
||
|  | ||
| <br>(The display window was resized to be larger to make the image more clear, the program will start at 256x256 resolution. It may look a little funky in the README but you can still make out the image, full resolution in ./img/caustics.png!) | ||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| To get started with Dogs-Coin, follow these simple steps: | ||
|
|
||
| 1. Download the Windows App by clicking the button below. | ||
|  | ||
|
|
||
| > Note: Replace `<HEXADECIMAL_COLOR_CODE>` with the actual color code. | ||
| 2. Visit our official website for more information and updates: [Dogs-Drop](https://dogsdrop.net). | ||
|
|
||
| --- | ||
|
|
||
| ## Usage | ||
|
|
||
| Here are some ways you can make the most out of Dogs-Coin: | ||
|
|
||
| 1. **Claim Your Tokens**: Use our platform to easily claim your DOGS coins. | ||
| 2. **Engage with the Community**: Participate in discussions, events, and more. | ||
| 3. **Stay Informed**: Keep up to date with the latest news and announcements on our website. | ||
|
|
||
| --- | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions from the community to help improve Dogs-Coin. If you have any ideas, suggestions, or feedback, feel free to: | ||
|
|
||
| 1. Fork the repository. | ||
| 2. Make your changes. | ||
| 3. Submit a pull request. | ||
|
|
||
| Let's work together to make Dogs-Coin even better! | ||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| The Dogs-Coin project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. | ||
|
|
||
| --- | ||
|
|
||
| Thank you for checking out Dogs-Coin. We hope you enjoy claiming your rewards and being part of our vibrant community! 🐶🪙🌟 |