Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: improve the guide for running macos applications bundle #183

Merged
merged 2 commits into from
Aug 8, 2024
Merged

doc: improve the guide for running macos applications bundle #183

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45b0732
doc: improve the guide for running macos applications bundle
Aug 7, 2024
7ebc2d6
Update docs/installation_JA.md
VitoVan Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ For more applications made with CALM, please check [Made with CALM](https://gith

3. Add the extracted directory into your PATH environment

for macOS, add `/path/to/Calm.app/Contents/MacOS/` instead
for macOS, add `/Applications/Calm.app/Contents/MacOS/` instead

For macOS and Windows users, you need to be smarter than [Windows SmartScreen](https://duckduckgo.com/?q=how+to+bypass+smartscreen) or able to [tame macOS](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac) to use CALM. In case anything went wrong, here is an [Installation Guide](docs/installation.md).
For macOS and Windows users, you need to be smarter than [Windows SmartScreen](https://www.google.com/search?q=how+to+get+around+windows+smartscreen) or able to [tame macOS](https://www.google.com/search?q=how+to+remove+quarantine+flags+in+macos) to use CALM. In case anything went wrong, here is an [Installation Guide](docs/installation.md).

### Run from Source

Expand Down
4 changes: 2 additions & 2 deletions README_JA.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ CALM で作られた他のアプリケーションについては、[Made with C

3. 解凍したディレクトリを PATH 環境に追加する

macOS の場合は、代わりに `/path/to/Calm.app/Contents/MacOS/` を追加する
macOS の場合は、代わりに `/Applications/Calm.app/Contents/MacOS/` を追加する

macOS と Windows ユーザーの場合、CALM を使うには [Windows SmartScreen](https://duckduckgo.com/?q=how+to+bypass+smartscreen) よりもスマートであるか、[macOS を飼いならす事](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac)ができる必要があります。万が一何かあったときのために、ここに[インストールガイド](docs/installation_JA.md)があります。
macOS と Windows ユーザーの場合、CALM を使うには [Windows SmartScreen](https://www.google.com/search?q=how+to+get+around+windows+smartscreen) よりもスマートであるか、[macOS を飼いならす事](https://www.google.com/search?q=how+to+remove+quarantine+flags+in+macos)ができる必要があります。万が一何かあったときのために、ここに[インストールガイド](docs/installation_JA.md)があります。

### ソースからの実行

Expand Down
16 changes: 10 additions & 6 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,19 @@ Now let's set up the environment for the ease of use.
- macOS
1. Open the downloaded DMG file

2. Drage the .app to the Applications folder
2. Drag the .app to the Applications folder

3. Eject the DMG and run Calm.app
3. Trust me and de-quarantine Calm.app

**It may take a while** for the first run.
```bash
xattr -d com.apple.quarantine /Applications/Calm.app
```

> On macOS, it's very likely the system will stop you from running the software, since it's not verified by Apple. If you have problem to run it, please check [this](https://support.apple.com/HT202491).
4. Eject the DMG and run Calm.app

**It may take a while** for the first run.

4. Add command `calm` to the PATH environment
5. Add command `calm` to the PATH environment

```bash
echo 'export PATH="/Applications/Calm.app/Contents/MacOS/:$PATH"'>> ~/.bashrc
Expand All @@ -42,7 +46,7 @@ Now let's set up the environment for the ease of use.
> echo 'export PATH="/c/calm/:$PATH"' >> ~/.bashrc
> ```

> On Windows, it's very likely the system will stop you from running the software, since it's not verified by Microsoft. If you have problem to run it, please [find a way to bypass SmartScreen](https://duckduckgo.com/?q=how+to+bypass+smartscreen).
> On Windows, it's very likely the system will stop you from running the software, since it's not verified by Microsoft. If you have problem to run it, please [find a way to bypass SmartScreen](https://www.google.com/search?q=how+to+get+around+windows+smartscreen).


Now you are all set, enjoy.
14 changes: 9 additions & 5 deletions docs/installation_JA.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@

2. .app をアプリケーションフォルダにドラッグします

3. DMG を取り出し、Calm.app を実行する
3. Trust me and de-quarantine Calm.app
VitoVan marked this conversation as resolved.
Show resolved Hide resolved

初回の実行には **時間がかかるかもしれません。**
```bash
xattr -d com.apple.quarantine /Applications/Calm.app
```

> macOS の場合、Apple によって検証されていないため、システムによってソフトウェアの実行が停止される確率が非常に高いです。実行に問題がある場合は、[こちら](https://support.apple.com/HT202491)を確認してください。
4. DMG を取り出し、Calm.app を実行する

初回の実行には **時間がかかるかもしれません。**

4. コマンド `calm` を PATH 環境に追加する
5. コマンド `calm` を PATH 環境に追加する

```bash
echo 'export PATH="/Applications/Calm.app/Contents/MacOS/:$PATH"'>> ~/.bashrc
Expand All @@ -42,7 +46,7 @@
> echo 'export PATH="/c/calm/:$PATH"' >> ~/.bashrc
> ```

> Windows の場合、マイクロソフト社によって検証されていないため、システムがソフトウェアの実行を停止する確率が非常に高いです。実行に問題がある場合は、[SmartScreen をバイパスする方法を見つけてください](https://duckduckgo.com/?q=how+to+bypass+smartscreen)。
> Windows の場合、マイクロソフト社によって検証されていないため、システムがソフトウェアの実行を停止する確率が非常に高いです。実行に問題がある場合は、[SmartScreen をバイパスする方法を見つけてください](https://www.google.com/search?q=how+to+bypass+smartscreen)。


これで準備万端、お楽しみください。
Loading