|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en"> |
| 3 | + |
| 4 | +<head> |
| 5 | + <meta charset="UTF-8"> |
| 6 | + <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 7 | + <title>Struct - Project Structure Generator</title> |
| 8 | + <link rel="stylesheet" href="css/style.css"> |
| 9 | + <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css"> |
| 10 | +</head> |
| 11 | + |
| 12 | +<body> |
| 13 | + <header> |
| 14 | + <div class="container"> |
| 15 | + <h1><i class="fas fa-project-diagram"></i> Struct</h1> |
| 16 | + <p>Your versatile project structure generator</p> |
| 17 | + </div> |
| 18 | + </header> |
| 19 | + <main class="container"> |
| 20 | + <section> |
| 21 | + <h2>About</h2> |
| 22 | + <p>Struct is a powerful tool to automate the creation of project structures based on YAML configurations. It |
| 23 | + supports template variables, OpenAI integration for generating content, and various file handling |
| 24 | + strategies to customize your project setup.</p> |
| 25 | + </section> |
| 26 | + <section> |
| 27 | + <h2>Features</h2> |
| 28 | + <ul> |
| 29 | + <li>Define project structure using YAML</li> |
| 30 | + <li>Support for template variables</li> |
| 31 | + <li>Integration with OpenAI for content generation</li> |
| 32 | + <li>Flexible file handling strategies (overwrite, skip, append, rename, backup)</li> |
| 33 | + <li>Modular YAML inclusion for nested structures</li> |
| 34 | + <li>Dry-run mode to preview changes without making them</li> |
| 35 | + </ul> |
| 36 | + </section> |
| 37 | + <section> |
| 38 | + <h2>Getting Started</h2> |
| 39 | + <p>To get started with Struct, follow these simple steps:</p> |
| 40 | + <ol> |
| 41 | + <li>Clone the repository</li> |
| 42 | + <li>Define your project structure in a YAML file</li> |
| 43 | + <li>Run Struct with your YAML configuration</li> |
| 44 | + </ol> |
| 45 | + <pre><code>git clone https://github.com/yourusername/struct.git |
| 46 | +cd struct |
| 47 | +python your_script.py path/to/project_structure.yaml /path/to/your/project --config-file=config.yaml</code></pre> |
| 48 | + </section> |
| 49 | + <section> |
| 50 | + <h2>Documentation</h2> |
| 51 | + <p>For detailed documentation, please visit our <a href="https://github.com/yourusername/struct/wiki" |
| 52 | + target="_blank">GitHub Wiki</a>.</p> |
| 53 | + </section> |
| 54 | + <section> |
| 55 | + <h2>Contribute</h2> |
| 56 | + <p>We welcome contributions from the community! Please read our <a |
| 57 | + href="https://github.com/yourusername/struct/blob/main/CONTRIBUTING.md" target="_blank">contributing |
| 58 | + guidelines</a> to get started.</p> |
| 59 | + </section> |
| 60 | + </main> |
| 61 | + <footer> |
| 62 | + <div class="container"> |
| 63 | + <p>© 2024 Struct Project</p> |
| 64 | + <p><a href="https://github.com/yourusername/struct" target="_blank"><i class="fab fa-github"></i> GitHub</a> |
| 65 | + </p> |
| 66 | + </div> |
| 67 | + </footer> |
| 68 | + <script src="js/script.js"></script> |
| 69 | +</body> |
| 70 | + |
| 71 | +</html> |
0 commit comments