Skip to content

Commit

Permalink
doc: format README.md with prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
torkelrogstad committed Feb 28, 2024
1 parent 13c57c9 commit 79fcd31
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 27 deletions.
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"proseWrap": "always"}
59 changes: 32 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

This application is built using [Godot](https://github.com/godotengine/godot).

Godot may seem like an odd choice at first glance, but with its cross-platform abilities and an amazing set of GUI & IO features, it makes it very capable for this application.
Godot may seem like an odd choice at first glance, but with its cross-platform
abilities and an amazing set of GUI & IO features, it makes it very capable for
this application.

We can currently run on Mac, Windows, and Linux.

Expand All @@ -14,7 +16,8 @@ If you'd like to build from source, check below.

- Godot 4.1.1 [Download Page](https://godotengine.org/download)

Currently only scripted in GDScript, but we could use the .NET version of Godot which brings C# support.
Currently only scripted in GDScript, but we could use the .NET version of Godot
which brings C# support.

Once you've gotten your development environment set up:

Expand All @@ -23,42 +26,44 @@ Once you've gotten your development environment set up:

### Important

The app relies on external binaries to be downloaded from a specific GitHub release. This is a bit cumbersome,
but was the best we could come up with for now.
The app relies on external binaries to be downloaded from a specific GitHub
release. This is a bit cumbersome, but was the best we could come up with for
now.

- chain_providers.cfg are where each of the sidechain configs starts.
The hash and file size for each platform binary is manually generated and added to the config
for the release if it has changed.
- chain_providers.cfg are where each of the sidechain configs starts. The hash
and file size for each platform binary is manually generated and added to the
config for the release if it has changed.
- version.cfg is where you would update the version and base GitHub release URL.
Sometimes you may need to create a pre-release, upload all the binaries there and point to that
as you are developing.
- Currently, each platform version is built on its respective platform. So build the launcher for Linux on Linux,
Mac on Mac, and Windows on Windows.
- Mac is a bit different as you need to have a developer ID certificate so that Godot can request a signature and
notarization. Whoever does this will need to create a signing certificate request and have Paul then create a
new developer ID certificate with that request. Then you would install that into your Mac keychain.
More info here: https://developer.apple.com/help/account/create-certificates/create-developer-id-certificates
Sometimes you may need to create a pre-release, upload all the binaries there
and point to that as you are developing.
- Currently, each platform version is built on its respective platform. So build
the launcher for Linux on Linux, Mac on Mac, and Windows on Windows.
- Mac is a bit different as you need to have a developer ID certificate so that
Godot can request a signature and notarization. Whoever does this will need to
create a signing certificate request and have Paul then create a new developer
ID certificate with that request. Then you would install that into your Mac
keychain. More info here:
https://developer.apple.com/help/account/create-certificates/create-developer-id-certificates

### LICENSE

MIT License

Copyright (c) 2023 Layer Two Labs

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit 79fcd31

Please sign in to comment.