From bbe9051193689a44368592a454dec00ba035acd7 Mon Sep 17 00:00:00 2001 From: Moritz Vogel Date: Thu, 6 Mar 2025 15:16:32 +0100 Subject: [PATCH] Add usage instructions to README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b73c39..6e8c2cf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ -# 3d +# 3D City Editor -A 3D editor to manipulate cityscapes. Built during an university project. +A 3D editor to manipulate cityscapes. Built during a university project. + +## Usage + +There is no *open project* dialog implemented yet, so the project path has to be specified via a CLI argument. +``` +./3d +``` +If a path to a directory is provided, the containing project is loaded, or a new project is created there. Without an argument, the current working directory is used instead. +In case the path points to a model file, a new project in the working directory is created and the given file is loaded. ## Building