Skip to content
This repository has been archived by the owner on Dec 21, 2024. It is now read-only.

Commit

Permalink
update README.md (Add cli usage, TOC, ...)
Browse files Browse the repository at this point in the history
  • Loading branch information
doctorixx committed Aug 9, 2024
1 parent a5091c2 commit 4e4a390
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 5 deletions.
58 changes: 53 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Github Skyline (Alternative) ![](https://img.shields.io/badge/export-stl-blue)
# Github Skyline (Alternative)
![](https://img.shields.io/badge/export-stl-blue)


Alternative of https://skyline.github.com/

Expand All @@ -7,22 +9,38 @@ ___
![](images/render.png "Github skyline render")
___

<!-- TOC -->
* [Github Skyline (Alternative)](#github-skyline-alternative-)
* [Usage](#usage)
* [UI usage](#ui-usage)
* [Windows](#windows)
* [Linux and Mac](#linux-and-mac)
* [CLI usage](#cli-usage)
* [MacOS / Linux](#macos--linux)
* [Windows](#windows-1)
* [Python usage](#python-usage)
* [Compatibility](#compatibility)
* [Developments builds](#developments-builds)
<!-- TOC -->

## Usage

- Go to the latest release and select your platform
![](images/release_assets.png "Github skyline render")
![](images/release_assets.png "Github skyline render")
- Download your system archive
- Unzip archive

### UI usage

#### Windows

### Windows
![](images/windows_open.png "Github skyline render")

- Double-click on downloaded file

![](images/windows_work_example.png "Github skyline render")

### Linux and Mac
#### Linux and Mac

- Run the download binary

Expand All @@ -32,6 +50,25 @@ ___

![](images/linux_run_example.png "Github skyline render")

### CLI usage

(Use same file)

![img.png](images/cli_options.png)

Example:

#### MacOS / Linux

```shell
./skyline-wizard.bin -u doctorixx -y 2024
```

#### Windows

```shell
./skyline-wizard.exe -u doctorixx -y 2024
```

## Python usage

Expand Down Expand Up @@ -76,5 +113,16 @@ Check "*.stl" fies in project root
![](images/stl_file.png "Stl file in explorer")
## Compatibility
(Checked binaries, With Python app works correctly on all platforms)
| OS | x64 | arm64 |
|---------|:---:|:-----:|
| MacOS |||
| Linux |||
| Windows |||
## Developments builds
You can find developments build in GitHub Actions
You can find developments build in GitHub Actions
Binary file added images/cli_options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4e4a390

Please sign in to comment.