Skip to content

Commit

Permalink
Reverted Platform.Bible rename changes
Browse files Browse the repository at this point in the history
Changed Readme to use assets/icon.svg
  • Loading branch information
tombogle committed Sep 10, 2024
1 parent a78170c commit b7ef1fc
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 19 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Extensible Bible translation software

<div align="center">
<img src="doc-meta/doc-icon.png" />
<img src="./assets/icon.svg" width="256" alt="Platform icon" />
</div>

<div align="center">
Expand All @@ -16,15 +16,15 @@ Extensible Bible translation software

## Summary

Platform is extensible Bible translation software. Its functionality is provided almost completely by extensions in order to be very powerful and flexible, giving developers the freedom to create and to share their desired Bible translation experience.
Platform.Bible is extensible Bible translation software. Its functionality is provided almost completely by extensions in order to be very powerful and flexible, giving developers the freedom to create and to share their desired Bible translation experience.

This repository contains the core Platform software (Electron client, extension host including "PAPI", and .NET library) and the extensions that come bundled with it. There are many other repositories containing additional Platform extensions.
This repository contains the core Platform.Bible software (Electron client, extension host including "PAPI", and .NET library) and the extensions that come bundled with it. There are many other repositories containing additional Platform extensions.

## Users

This software is not yet ready for users. We'll update here with where you can install it when it is ready.

If you would still like to try Platform, you can [download early releases here on GitHub](https://github.com/paranext/paranext-core/releases).
If you would still like to try it, you can [download early releases here on GitHub](https://github.com/paranext/paranext-core/releases).

### Linux Users

Expand All @@ -38,13 +38,13 @@ Then simply [execute/run](https://github.com/AppImage/AppImageKit/wiki) the `.Ap

### Mac Users

If you download and run the ARM release of Platform from [a computer running Apple Silicon](https://support.apple.com/en-us/116943), you will likely encounter a warning from Apple's Gatekeeper stating that "Platform.Bible is damaged and can't be opened. You should move it to the Trash." or something very similar:
If you download and run the ARM release of Platform.Bible from [a computer running Apple Silicon](https://support.apple.com/en-us/116943), you will likely encounter a warning from Apple's Gatekeeper stating that "Platform.Bible is damaged and can't be opened. You should move it to the Trash." or something very similar:

![mac-arm-damaged-warning](doc-meta/mac-arm-damaged-warning.png)

Unfortunately, this is the message Apple chose to display for ARM applications that are not signed (including Platform since we have not yet set up application code signing on Mac).
Unfortunately, this is the message Apple chose to display for ARM applications that are not signed (including Platform.Bible, since we have not yet set up application code signing on Mac).

If you trust Platform and would like to run it even though it is not code signed, you will need to run the following terminal command every time you install a new version of Platform:
If you trust Platform.Bible and would like to run it even though it is not code signed, you will need to run the following terminal command every time you install a new version of it:

`xattr -c /Applications/Platform.Bible.app`

Expand All @@ -62,7 +62,7 @@ Add the system libraries needed for Electron, [Build Instructions (Linux)](https

macOS doesn't come preinstalled with all the
[icu4c](https://unicode-org.github.io/icu/userguide/icu4c/) libraries. They must be
installed separately to provide Unicode support to our .NET code. Platform is
installed separately to provide Unicode support to our .NET code. Platform.Bible is
configured to expect those libraries to be installed using
[MacPorts](https://www.macports.org/). The
[icu package on MacPorts](https://ports.macports.org/port/icu/) has the icu4c
Expand Down Expand Up @@ -130,15 +130,15 @@ Please see the [Extension Template wiki](https://github.com/paranext/paranext-ex

## GitHub Pages

**[Platform API Documentation](https://paranext.github.io/paranext-core/papi-dts)**
**[Platform.Bible API Documentation](https://paranext.github.io/paranext-core/papi-dts)**

- Explore the declarations of types available on the PAPI.

**[Platform React Components and Hooks Documentation](https://paranext.github.io/paranext-core/platform-bible-react)**
**[Platform.Bible React Components and Hooks Documentation](https://paranext.github.io/paranext-core/platform-bible-react)**

- Check out the React components and hooks available to use.

**[Platform Utilities Documentation](https://paranext.github.io/paranext-core/platform-bible-utils)**
**[Platform.Bible Utilities Documentation](https://paranext.github.io/paranext-core/platform-bible-utils)**

- Check out the utility functions, types, and classes available to use.

Expand Down
3 changes: 2 additions & 1 deletion assets/localization/en.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"%product_name%": "Platform.Bible",
"%insertNote%": "Insert Note",
"%mainMenu_aboutPlatform%": "About Platform",
"%mainMenu_about%": "About Platform.Bible",
"%mainMenu_downloadSlashInstallResources%": "Download/Install Resources",
"%mainMenu_downloadSlashUpdateProject%": "Download/Update Project",
"%mainMenu_exit%": "Exit",
Expand Down
2 changes: 1 addition & 1 deletion electron-builder.json5
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @see https://www.electron.build/configuration/configuration
*/
{
productName: 'Platform',
productName: 'Platform.Bible',
appId: 'org.paranext.PlatformBible',
copyright: 'Copyright © 2022-2024 SIL International',
asar: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface CommandHandler {
export type MenuPropsBase = {
/*
* The JSON defining the menu whose items are to be rendered. This will typically be one of the
* menus in the "defs" in a Platform menu (see PlatformMenus). The schema for this is
* menus in the "defs" in a Platform.Bible menu (see PlatformMenus). The schema for this is
* menuDocumentSchema (at the end of menus.model.ts). Note that while this is a
* "SingleColumnMenu", somewhat bizarrely, a MultiColumnMenu is a SingleColumnMenu, so it really
* could be a MultiColumnMenu, in which case, column had better be defined so it can be used
Expand Down
4 changes: 2 additions & 2 deletions src/extension-host/data/menu.data.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@
"command": "platform.visitSupportPage"
},
{
"label": "%mainMenu_aboutPlatform%",
"localizeNotes": "Application main menu > Help > About Platform",
"label": "%mainMenu_about%",
"localizeNotes": "Application main menu > Help > About (Platform.Bible or Software white-label name)",
"group": "platform.helpMisc",
"order": 2,
"command": "platform.about"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ type PlatformTabTitleProps = {
webViewType?: `${string}.${string}`;
/** Id of the tab this title is on */
tabId: string;
/** Url to image to show on the tab. Defaults to Platform logo */
/** Url to image to show on the tab. Defaults to Platform.Bible logo */
iconUrl?: string;
/** Text to show on the tab */
text: string;
Expand All @@ -22,7 +22,7 @@ type PlatformTabTitleProps = {
/**
* Custom tab title for all tabs in Platform
*
* @param iconUrl Url to image to show on the tab. Defaults to Platform logo
* @param iconUrl Url to image to show on the tab. Defaults to Platform.Bible logo
* @param text The text to show on the tab title
* @param tooltip Text to show when hovering over the tab. Defaults to empty string
*/
Expand Down
2 changes: 1 addition & 1 deletion src/renderer/testing/about-panel.component.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default function AboutPanel() {
<div className="about-panel">
<div className="hello">
<LockupInlinePlatformIcon />
<p>Copyright © 2022-2024 SIL</p>
<p>Copyright © 2022-2024 SIL International</p>
<p>Version: {PackageInfo.version}</p>
<p>License: {PackageInfo.license}</p>
<p>{PackageInfo.description}</p>
Expand Down

0 comments on commit b7ef1fc

Please sign in to comment.