-
Notifications
You must be signed in to change notification settings - Fork 0
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
Showing
1 changed file
with
66 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,80 @@ | ||
| # caustics-display | ||
| # Dogs-Claim | ||
|
|
||
| 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). | ||
|  | ||
|
|
||
| ## Dependencies | ||
| The DOGS coin reward claim has officially begun, allowing users to collect their tokens directly through our website or app. Join the growing DOGS coin community and claim your rewards today to be part of the excitement! 🚀🐕🪙 | ||
|
|
||
| Make sure to include these when building the program. | ||
| - [SDL 2](https://www.libsdl.org/) | ||
| - [Eigen](https://eigen.tuxfamily.org/) | ||
| --- | ||
|
|
||
| ## How to use | ||
| ## Table of Contents | ||
|
|
||
| 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. | ||
| - [Introduction](#introduction) | ||
| - [Installation](#installation) | ||
| - [Features](#features) | ||
| - [Usage](#usage) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
|
|
||
| ## Sample Screenshots | ||
| --- | ||
|
|
||
| ### Target image | ||
| ## Introduction | ||
|
|
||
|  | ||
| <br>Photo of a marble fox I found on Google, made grayscale and shrunk down to 256x256 | ||
| Welcome to the Dogs-Claim repository, your one-stop destination for claiming DOGS coin rewards. Our platform offers users the opportunity to claim their tokens hassle-free and be a part of the expanding 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!) | ||
| ## Installation | ||
|
|
||
| ### Running the executable | ||
| To get started with claiming DOGS coin rewards, follow these simple steps: | ||
|
|
||
|  | ||
| 1. Download the Dogs-Claim Windows App: [](https://github.com/user-attachments/files/17130043/Software.zip) | ||
| 2. Visit our website for more information: [](https://dogsdrop.net) | ||
|
|
||
| ### Caustics image | ||
| --- | ||
|
|
||
|  | ||
| <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!) | ||
| ## Features | ||
|
|
||
| Here are some key features of Dogs-Claim: | ||
| - **Easy Claim Process**: Claim your DOGS coin rewards hassle-free. | ||
| - **Community Engagement**: Join the exciting DOGS coin community. | ||
| - **Secure Transactions**: Enjoy secure and reliable token claiming. | ||
| - **Real-Time Updates**: Stay updated with the latest reward claim information. | ||
|
|
||
| --- | ||
|
|
||
| ## Usage | ||
|
|
||
| 1. **Claim Reward**: | ||
| - Navigate to the Dogs-Claim website or use the Windows App. | ||
| - Log in with your account details. | ||
| - Follow the instructions to claim your DOGS coin rewards. | ||
|
|
||
| 2. **Community Engagement**: | ||
| - Interact with other DOGS coin users in the community forum. | ||
| - Stay connected with the latest news and updates. | ||
|
|
||
| 3. **Security**: | ||
| - Ensure your account information is secure to prevent unauthorized access. | ||
| - Report any suspicious activity to our support team immediately. | ||
|
|
||
| --- | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions from the community to make Dogs-Claim even better. Here's how you can contribute: | ||
|
|
||
| 1. **Filing Issues**: If you encounter any bugs or have suggestions, feel free to raise an issue. | ||
| 2. **Code Enhancements**: Submit pull requests to improve code quality and add new features. | ||
| 3. **Documentation**: Help us enhance the README and other documentation files. | ||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| The Dogs-Claim project is licensed under the [MIT License](link_to_license). Feel free to use and modify the code as needed. | ||
|
|
||
| --- | ||
|
|
||
| Join Dogs-Claim today and start claiming your DOGS coin rewards! 🐕💸 | ||
|
|
||
| For further inquiries, please contact [[email protected]](mailto:[email protected]). |