{"id":43739278,"url":"https://github.com/flucoma/flucoma-docs","last_synced_at":"2026-02-05T11:25:19.882Z","repository":{"id":37083164,"uuid":"259240017","full_name":"flucoma/flucoma-docs","owner":"flucoma","description":"Documentation for Fluid Corpus Manipulation","archived":false,"fork":false,"pushed_at":"2025-12-20T17:35:44.000Z","size":1518,"stargazers_count":8,"open_issues_count":18,"forks_count":10,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-12-22T18:37:11.818Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"SuperCollider","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/flucoma.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-04-27T07:34:54.000Z","updated_at":"2025-12-20T17:35:48.000Z","dependencies_parsed_at":"2024-03-19T12:28:35.786Z","dependency_job_id":"35582ee9-14fd-44d1-9bb0-4218f5147298","html_url":"https://github.com/flucoma/flucoma-docs","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/flucoma/flucoma-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flucoma%2Fflucoma-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flucoma%2Fflucoma-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flucoma%2Fflucoma-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flucoma%2Fflucoma-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flucoma","download_url":"https://codeload.github.com/flucoma/flucoma-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flucoma%2Fflucoma-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29120496,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T10:47:47.471Z","status":"ssl_error","status_checked_at":"2026-02-05T10:45:08.119Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-02-05T11:25:19.055Z","updated_at":"2026-02-05T11:25:19.872Z","avatar_url":"https://github.com/flucoma.png","language":"SuperCollider","funding_links":[],"categories":[],"sub_categories":[],"readme":"Produce documentation for [Fluid Corpus Manipulation Library](https://github.com/flucoma/flucoma-core) objects, from a combination of handwritten material and generated data. \n\n## Overview \nThe generated data comes from building an running a set of C++ executables that produce JSON files detailing the interface of FluCoMa objects (parameter and message names, etc.). \n\nThe handwritten documentation is in reStructuredText files that are meant to match up with the generated data. Some Python code then makes sure this assumption is true (i.e. validates the completeness of the handwritten docs against the generated data), and produces rendered documentation for a choice of environments (Max, Pure Data, Supercollider and the command line). \n\nThis is intended principally as internal tooling, so there may well be rough edges and weird things. Operation on platforms other than Mac OS or Linux is untested. \n\n## Quick Start \n\nThe routine way to interact with everything is via CMake. In addition to this you will need: git, a working C++ toolchain, and Python \u003e= 3.8 with the packages listed in `requirements.txt`. (use `pip install -r requirements.txt` to install all these in one go. )\n\nTo configure the project and generate the JSON run\n```bash\nmkdir build\ncd build\ncmake ..\nmake\n```\n\nIf you have a local checkout of the `flucoma-core` repo, then this can be used by adding `-DFLUID_PATH=\u003cpath to your flucoma core\u003e`. \n\nThe JSON files are generated into `build/json`.\n\nThe CMake exposes targets for producing docs for particular environments (`MAKE_MAX_REF`, `MAKE_PD_REF`, `MAKE_SC_REF`,`MAKE_CLI_REF`). These targets will (re-)generate the JSON if needed and then run a Python script to produce the actual docs. \n\nThe output paths for the docs default to `build/\u003chost\u003e_ref` but can be overridden by setting CMake cache variables (`MAX_DOC_OUT`,`PD_DOC_OUT`,`CLI_DOC_OUT`,`SC_DOC_OUT`)\n\n### Python Herding\nOn platforms with multiple Pythons installed (like Macs), CMake can sometimes need some heavy hints in order to avoid settling on system Python. If you get error messages about missing packages, it is likely that CMake has found the 'wrong' one. \n\nFor recent versions of CMake (\u003e= 3.15?), adding `-DPython_EXECUTABLE=\u003cpath to your python of choice\u003e` is a blunt instrument, but normally works. You can find the path via `which python` in the terminal, if needed. Considerably more options can be found in the [documentation for CMake's `find_python` module](https://cmake.org/cmake/help/latest/module/FindPython.html). \n\n## Documentation \n\nIs still thin, but will gather mass in the `code-docs` directory. \n\n## Credits \n#### FluCoMa core development team (in alphabetical order)\nOwen Green, Gerard Roma, Pierre Alexandre Tremblay\n\n#### Other contributors (in alphabetical order):\nJames Bradbury, Francesco Cameli, Alex Harker, Ted Moore\n\n\u003e This project has received funding from the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflucoma%2Fflucoma-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflucoma%2Fflucoma-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflucoma%2Fflucoma-docs/lists"}