Skip to content

README.md

Latest commit

 

History

History
64 lines (44 loc) · 1.5 KB

README.md

File metadata and controls

64 lines (44 loc) · 1.5 KB

Omoospace

中文文档

overview

Omoospace is a universal folder structure guideline for creative projects. Its goals are universality, flexibility, and semantic clarity. It works for complex projects and team collaboration, as well as simple projects and individual work. Why Omoospace?

Getting Started

New Project

  1. Create a new folder as the project root.
  2. Create Omoospace.yml in the root.
  3. Create Contents/ in the root and put your resource files in it.
  4. (Optional) Create Subspaces/ in the root and put your source files in it.
  5. (Optional) Add other folders as needed and place the corresponding file types in them.

Existing Project

  1. Create Omoospace.yml in the project root.

  2. Edit Omoospace.yml and add:

    contents_dir: <resource_folder_name>

    Example:

    contents_dir: Assets

  3. (Optional) Edit Omoospace.yml and add:

    subspaces_dir: <source_folder_name>

    Example:

    subspaces_dir: ProjectFiles

Command Line Tool

Install uv and tool

https://docs.astral.sh/uv/getting-started/installation/

uv tool install omoospace[cli]

New Project

omoos create <Name>

Existing Project

cd <project folder>
omoos init