Skip to content

Commit

Permalink
chore: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
sylv256 committed Sep 3, 2024
1 parent 9d4f3b7 commit ee1bc86
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Project SIGILL
<sub>Copyright (c) 2024 Sylv</sub>
An attempt to bring space-faring endeavours to Rust.

## License
Currently, SIGILL is ARR (All Rights Reserved). This may change in the future, especially as SIGILL gains contributors; however, SIGILL will likely never be Open Source.

## Price
Project SIGILL has no plans of publishing to game platforms. This is because it requires the latest Vulkan features that most computers do not support, let alone mobile devices and consoles. This game will never be ported to console.

## Compiling
You are free to compile and play the game (SIGILL) in its current state given that you do not redistribute the source code and/or binary executables.

### Dependencies
SIGILL requires the [LunarG Vulkan SDK](https://vulkan.lunarg.com/sdk/home) available for Linux or Windows. SIGILL does not officially support macOS. SIGILL also requires [Rust](https://rustup.rs/) (obviously).

#### Windows
On Windows, SIGILL requires the [Visual Studio C++ Build Tools](https://visualstudio.microsoft.com/downloads/).

0 comments on commit ee1bc86

Please sign in to comment.