Updated README.md and installation files #184
Conversation
| - [x] Windows | ||
| - [x] OSX | ||
| - [x] macOS |
There was a problem hiding this comment.
MacOS I think is the preferred capitalization?
There was a problem hiding this comment.
I have checked, Apple use now macOS brand name to match, iOS, tvOS, watchOS: https://support.apple.com/macos
Also here some more info about branding: https://www.macworld.com/article/672681/list-of-all-macos-versions-including-the-latest-macos.html
README.md
Outdated
|
|
||
| ### Installation | ||
|
|
||
| You can find detailed instructions on how to install applications on various platforms [here](https://github.com/LeastAuthority/destiny/blob/main/doc/installation.md) |
There was a problem hiding this comment.
I always prefer to avoid "here" link-text.
Maybe "We have [detailed instructions on how to install] the application on various platforms." (with the stuff in "[" being the link).
README.md
Outdated
|
|
||
| ### Verification | ||
|
|
||
| We recommend verifying every downloaded file. Instructions [here](https://github.com/LeastAuthority/destiny/blob/main/doc/releases.md). |
There was a problem hiding this comment.
Similar comment for this. Maybe "We recommend [verifying every downloaded file] against the corresponding signature".
README.md
Outdated
| ``` | ||
|
|
||
| More information on signing releases can be found [here](https://github.com/LeastAuthority/destiny/blob/main/doc/releases.md) |
There was a problem hiding this comment.
Maybe "There are further [details of our signing process] available."
README.md
Outdated
|
|
||
| ## Other | ||
|
|
||
| - **FAQ** can be found [here](https://github.com/LeastAuthority/destiny/blob/main/FAQ.md). |
There was a problem hiding this comment.
Similar, I'd try wording these so the important text is the link. like "We have an [FAQ], a [Privacy Policy], and [Terms & Conditions'." Or. to keep a list, just link like "[Our FAQ]", "Our [Privacy Policy]", etc...
There was a problem hiding this comment.
Thanks I will update this
| 2. Open `destiny_android.apk` file | ||
| 3. There might be a popup asking if you really want to install, press Install | ||
|
|
||
| **Note**: *installing directly is not recommended, also there won't be automatic updates* |
| **Note**: might require additional libraries | ||
|
|
||
|
|
||
| ## macOS (M1 or Intel chip based) |
There was a problem hiding this comment.
If the other macOS -> MacOS then this should change too.
doc/installation.md
Outdated
| 2. Run chmod u+x `destiny_linux_amd64.AppImage && ./destiny_linux_amd64.AppImage` | ||
| **Note**: If your system does not have FUSE you can [extract the appimage](https://github.com/AppImage/AppImageKit/wiki/FUSE#type-2-appimage): | ||
| ``` | ||
| ./nvim.appimage --appimage-extract |
There was a problem hiding this comment.
This filename should be the thing downloaded, no?
| 2. Extract `tar xzvf destiny_linux_amd64.tar.gz` | ||
| 4. Go inside directory `destiny_linux` | ||
| 5. Run `./destiny` | ||
|
|
There was a problem hiding this comment.
If there are build instructions (e.g. for developers at least) would be good to at least link them here.
There was a problem hiding this comment.
There are some instructions in main README file for building. Maybe we can improve this separately.
There was a problem hiding this comment.
Can we file a ticket to remember to link the build instructions here, then, at least?
Co-authored-by: El-Hassan Wanas <wanas@leastauthority.com>
Code Review Checklist