Skip to content

Add usage instructions to README #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Birdy2014 merged 1 commit into from
Mar 12, 2025
Merged

Add usage instructions to README #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <path to directory or model>
```
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

Expand Down