{"id":23392720,"url":"https://github.com/readshade/readshade","last_synced_at":"2026-04-28T01:32:42.959Z","repository":{"id":258852788,"uuid":"875401561","full_name":"ReadShade/ReadShade","owner":"ReadShade","description":"A guide website for ReShade.","archived":false,"fork":false,"pushed_at":"2024-12-21T14:37:54.000Z","size":54525,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T11:53:24.553Z","etag":null,"topics":["documentation","markdown","mkdocs","reshade"],"latest_commit_sha":null,"homepage":"https://readshade.github.io/ReadShade/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ReadShade.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-19T21:54:54.000Z","updated_at":"2024-12-21T14:37:37.000Z","dependencies_parsed_at":"2024-12-20T07:29:48.527Z","dependency_job_id":null,"html_url":"https://github.com/ReadShade/ReadShade","commit_stats":null,"previous_names":["papadanku/readshade","readshade/readshade","readshade/readshade.github.io"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReadShade%2FReadShade","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReadShade%2FReadShade/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReadShade%2FReadShade/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReadShade%2FReadShade/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ReadShade","download_url":"https://codeload.github.com/ReadShade/ReadShade/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247873449,"owners_count":21010455,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","markdown","mkdocs","reshade"],"created_at":"2024-12-22T05:14:58.523Z","updated_at":"2026-04-28T01:32:42.955Z","avatar_url":"https://github.com/ReadShade.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# ReadShade\n\n## Project Overview\n\nReadShade is a Sphinx documentation project that provides a neutral and simple platform for sharing knowledge about ReShade, Depth3D, emulators, games, and hardware. It serves as a comprehensive resource for users and developers looking to enhance their gaming experience through post-processing effects and optimization techniques.\n\n## Project Structure\n\nThe documentation is organized into thematic domains within the `source/` directory:\n\n- **ReShade General**: Covers optimization, DXVK integration, and engine-specific tweaks.\n- **Learning**: Focuses on ReShadeFX shader development with step-by-step guides for creating and understanding shaders.\n- **Software**: Includes detailed guides for emulators (PCSX2), ReShade add-ons (ShaderToggler, REST), and comprehensive documentation for the CShade shader collection.\n- **Third-Party**: Features documentation for external tools like Depth3D and WibbleWobble, along with specialized hardware guides for Viture and Super Reality (SR) devices.\n- **Licensing**: Contains copyright information and software licenses relevant to the project components.\n\n## Organization \u0026 Navigation\n\nThe project maintains a clean, hierarchical structure for easy navigation:\n\n- **Root Index**: The `source/index.rst` file serves as the master table of contents, defining the primary sections of the documentation.\n- **Domain Indices**: Each domain subdirectory uses its own `index.rst` file with automatic discovery to include all relevant articles.\n- **Asset Management**: Images are stored in local `images/` subdirectories within each domain to keep content and assets logically grouped.\n\n## Technologies Used\n\nThis project utilizes:\n\n- **[Sphinx](https://www.sphinx-doc.org/)**: The primary engine for generating documentation.\n- **[reStructuredText (.rst)](https://docutils.sourceforge.io/rst.html)**: The markup language used for writing all documentation.\n- **[Shibuya Theme](https://shibuya.lepture.com/)**: A modern, clean visual theme for the generated output.\n- **[Python](https://www.python.org/)**: The programming language that powers Sphinx.\n- **[pip](https://pip.pypa.io/)**: The package manager for installing and maintaining project dependencies.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadshade%2Freadshade","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freadshade%2Freadshade","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadshade%2Freadshade/lists"}