agentleFS
Sign inStart free
spiriMirrorspiriMirror/libuipc/.cursor/skills/project-structure/SKILL.md

project-structure

Skill351 starsChanged 3 months agoApache-2.0View on GitHub

Overview of the main directories and important files in the repository. Use this to understand the project layout and find where code lives.

21 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use native-nostalgia-stack, software-engineering-excellence and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • frostneySkill

    native-nostalgia-stack

    Applies the user's FreePascal toolchain and its build, formatting, hook, and test contracts while leaving project-specific mechanics local. Use when scaffolding or working in a FreePascal project that follows this toolchain.

    Also in 3 projects that use this

  • frostneySkill

    software-engineering-excellence

    Applies the user's engineering standards during substantial technical work: preserve scope, use current evidence, delegate independent parts, and complete authorized outcomes. Use during substantial implementation, debugging, refactoring, or multi-part delivery work.

    Also in 3 projects that use this

  • withpiperSkill

    roadmap-review

    Audit roadmap health — issues, dependency order, spec coverage, doc freshness. Use when speccing a new initiative. Use when /phase-plan output looks suspicious. Use before /roadmap-create reruns.

    Also in 3 projects that use this

  • HamzaSheikh768Skill

    dependency-injection

    Leverages FastAPI's powerful Depends system for reusable authentication, database sessions, rate limiting, and business logic injection.

    Also in 3 projects that use this

  • MicrosoftSkill

    update-pr

    Update the pull request for the current session. Use when the user wants to push new changes to an existing PR.

    Also in 3 projects that use this

  • MicrosoftSkill

    authentication

    Wire this in whenever the app uses or connects to data — records, a database, entities, per-user data, row-level security — or when the user wants sign-in, accounts, login, or protected pages. Rayfin data is always accessed as an authenticated user, so **data implies auth**; only a static page over public data skips it. The starter ships as a no-auth "hello world" that previews with no backend, and the full Fabric auth scaffolding is already in the project — this skill wires it in: AuthProvider + bootstrapAuth in main.tsx, the route guard in App.tsx, the sign-in page, sign-out, and the env/deploy requirement. Triggers: auth, authentication, sign in, sign-in, login, log in, sign out, logout, account, user, identity, protect route, require login, gated page, data, database, records, per-user, row-level security, who is the current user, Fabric auth, Entra.

    Also in 3 projects that use this

  • +1 more from microsoft

The file

Create a free account to mount
Files
SKILL.md

Project Structure Guide

Overview of the main directories and important files in the repository.

Top-Level Directories

  • apps/ - C++ apps, benchmarks, examples, and tests (see apps/CMakeLists.txt).
  • assets/ - Scene assets and simulation data.
  • cmake/ - Shared CMake utilities and macros.
  • docs/ - Documentation, specs, and site assets.
  • include/ - Public C++ headers.
  • output/ - Generated outputs from simulations. (the contents is ignored by git)
  • python/ - Python package, tests, and metadata.
  • libuipc-samples/ - Tracked git submodule containing Python examples, benchmarks, and sample assets.
  • scripts/ - Utility scripts and notebooks.
  • src/ - Core C++ implementation.
  • xmake/ - XMake rules and build helpers.

Subfolder Purposes

apps/

  • app/ - Shared app utilities and test helpers.
  • benchmarks/ - Benchmark executables.
  • examples/ - Example applications (each in its own subfolder).
  • tests/ - C++ test suites grouped by feature area.

assets/

  • scenes/ - Scene README and references.
  • sim_data/ - Mesh assets (linemesh/, tetmesh/, trimesh/).

docs/

  • build_install/ - Build and install guides.
  • development/ - Developer docs and diagrams.
  • specification/ - API/spec references and constitutions.
  • tutorial/ - Tutorial content and media.
  • overrides/ - MkDocs HTML overrides.
  • stylesheets/ - Docs CSS.
  • javascripts/ - Docs JS.
  • media/ - Images for docs pages.
  • misc/ - Miscellaneous documentation.

include/

  • uipc/ - Public headers grouped by module (backend, core, geometry, io, etc.). The removed C++ GUI has no public header tree.

python/

  • src/uipc/ - Pure python code to enhance the C++ pybind11 bindings.
  • tests/ - Python test suite.

scripts/

  • optional_import/ - Optional dependency loaders.
  • symbol_calculation/ - Symbolic derivation notebooks and helpers.
  • SymEigen/ - SymEigen utilities, notebooks, and tests.

src/

  • backends/ - Backend implementations (common/, cuda/, none/).
    • common/ - Common utilities for all backends.
    • cuda/ - CUDA backend with CUDA kernels.
    • none/ - An empty backend that does nothing, as a template for creating a new backend or checking the basic functionality.
  • geometry/metis/ - Private C++ METIS implementation and required GKlib-derived support code, built as uipc_metis for mesh partitioning.
  • constitution/ - Physical constitution implementations.
  • core/ - Core engine systems and modules.
  • geometry/ - Geometry algorithms and data types.
  • io/ - Serialization and I/O.
  • pybind/ - C++/Python bindings.
  • sanity_check/ - Internal scene sanity checks to ensure the correctness of scene before the simulation.
  • usd/ - USD integration.
  • vdb/ - VDB integration.

The supported visualization frontend is the pure-Python polyscope layer at python/src/uipc/gui.py. CMake is the primary and wheel-tested build. XMake mirrors the active optional USD/VDB targets, disables ccache, and synchronizes pybind staging before packaging. Remaining dependency-version differences are documented in the build guide and the secondary-module guide.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free