From 00c71adb5d5b520e43ec66209f3d3baa8bd48b95 Mon Sep 17 00:00:00 2001 From: Vito Van Date: Wed, 7 Aug 2024 15:51:57 +0800 Subject: [PATCH] Deploy docs for 1.3.1 to gh-pages 1723017117 --- docs/changelog.org | 3 + docs/hacking.html | 928 -------------------------------------- docs/hacking_ja.html | 928 -------------------------------------- docs/installation.html | 835 ---------------------------------- docs/installation_ja.html | 835 ---------------------------------- 5 files changed, 3 insertions(+), 3526 deletions(-) delete mode 100644 docs/hacking.html delete mode 100644 docs/hacking_ja.html delete mode 100644 docs/installation.html delete mode 100644 docs/installation_ja.html diff --git a/docs/changelog.org b/docs/changelog.org index 266734b..76a2828 100644 --- a/docs/changelog.org +++ b/docs/changelog.org @@ -1,4 +1,7 @@ * CALM +** 1.3.1 +- fix macos-14 (arm64) codesign problem + https://apple.stackexchange.com/questions/258623/how-to-fix-killed-9-error-in-mac-os/470957#470957 ** 1.3.0 - upgrade SBCL to 2.4.7 - add macos-14 (arm64) support diff --git a/docs/hacking.html b/docs/hacking.html deleted file mode 100644 index 6afa596..0000000 --- a/docs/hacking.html +++ /dev/null @@ -1,928 +0,0 @@ - - - - - - - - - - - - - - - CALM - Canvas Aided Lisp Magic - - -
- -

Hacking CALM

-

With Pre-built Binaries

-

Step 1: Fork CALM

-

https://github.com/VitoVan/calm/fork

-

Step 2: Install CALM binary

-

https://github.com/VitoVan/calm#-installation

-

Step 3: Init Git Repository

-
# cd to your downloaded CALM binary directory
-# e.g. on macOS:
-cd /Applications/Calm.app/Contents/MacOS
-
-# init git
-git init .
-
-# add your fork to remote
-git remote add origin git@github.com:<your-name>/calm.git
-
-# fetch
-git fetch origin --depth=1
-
-# reset hard to origin/main
-git reset --hard origin/main
-

Now you can modify, push and create pull requests!

-

My Personal Favour

-

Personally, I would clone the repository somewhere else and make some symbol links into the directory of the downloaded binary, such as:

-
cd /Applications/Calm.app/Contents/MacOS
-
-rm -rf ./build
-rm -rf ./s
-rm -rf ./src
-
-ln -s ~/github/VitoVan/calm/build build
-ln -s ~/github/VitoVan/calm/s s
-ln -s ~/github/VitoVan/calm/src src
-

This won't cover all the source code, but normally it's enough.

-

Run From Source

-
    -
  1. -

    Preparation

    -
      -
    • -

      Linux

      -

      Sit tight.

      -
    • -
    • -

      macOS

      -

      You need a package manager, I suggest Homebrew.

      -

      MacPorts should work, but I haven't tried it.

      -
    • -
    • -

      Windows -You need a package manager, I suggest MSYS2.

      -

      I hate to ask Windows users to use Bash, but I haven't found any other options.

      -
    • -
    -
  2. -
  3. -

    Install SBCL & Quicklisp

    -

    SBCL binaries can be found here. It should also has been included in your package manager. You should be able to install it easily.

    -
      -
    • -

      Linux (Fedora)

      -
      sudo dnf install sbcl -y
      -
    • -
    • -

      macOS

      -
      brew install sbcl
      -
    • -
    • -

      Windows

      -
      winget install sbcl
      -
    • -
    -

    After you have installed SBCL, it should be accessible in your terminal.

    -
    -

    On Windows (MSYS2), you may need to set the PATH environment manually, like this:

    -
    echo 'export PATH="/c/program files/steel bank common lisp/:$PATH"' >> ~/.bashrc
    -source ~/.bashrc
    -
    -

    Now download and install Quicklisp:

    -
    curl -O https://beta.quicklisp.org/quicklisp.lisp
    -sbcl --non-interactive --load quicklisp.lisp \
    -     --eval "(quicklisp-quickstart:install)" \
    -     --eval "(ql-util:without-prompting (ql:add-to-init-file))"
    -
  4. -
  5. -

    Install dependencies

    -

    All you need is: libzstd, SDL2, SDL2_mixer, SDL2_image and Cairo.

    -
    -

    libzstd is required by the recent version of SBCL, and will be installed by your package manager automatically if you installed SBCL.

    -
    -

    Here I will provide some sample commands, hope this would be helpful:

    -
      -
    • Linux (Fedora) -
      sudo dnf install libzstd SDL2 SDL2_mixer SDL2_image cairo -y
      -
    • -
    • macOS -
      brew install zstd sdl2 sdl2_mixer sdl2_image cairo
      -
    • -
    • Windows (MSYS2) -
      -

      The code below definitely need to be adjusted for ARM devices, since they are installing x86_64 version libs. Packages can be found here.

      -
      -
      pacman -S --noconfirm --needed git \
      - mingw64/mingw-w64-x86_64-zstd \
      - mingw64/mingw-w64-x86_64-SDL2 \
      - mingw64/mingw-w64-x86_64-SDL2_mixer \
      - mingw64/mingw-w64-x86_64-SDL2_image \
      - mingw64/mingw-w64-x86_64-cairo
      -
    • -
    -
  6. -
  7. -

    Clone CALM & make a temporary launcher

    -
    # clone the source code
    -git clone https://github.com/VitoVan/calm.git ~/calm
    -cd ~/calm
    -
    -# make a temporary launcher
    -cat > "./calm" <<EOF
    -  cd "$HOME/calm"
    -  export CALM_APP_DIR=$(pwd)
    -  export CALM_HOME="$HOME/calm/"
    -  export CALM_CMD=show
    -  sbcl --load entry.lisp show
    -EOF
    -
    -chmod +x ./calm
    -
    -# add the launcher to PATH env
    -echo 'export PATH="$HOME/calm/:$PATH"' >> ~/.bashrc
    -
    -# Windows (MSYS2) user may need the following line:
    -# echo 'export PATH="/mingw64/bin/:$PATH"' >> ~/.bashrc
    -
    -# activate the ENV change
    -source ~/.bashrc
    -
    -# give it a try
    -calm
    -
  8. -
-

Congrats! You are all set!

-

Can't wait to see what you are going to build!

-

Building CALM

-

Currently CALM was built on github actions, you can find the workflow here.

-

If you have interests to build CALM and encountered any problem, please let me know.

-

I would be so glad to help.

-
-
- - diff --git a/docs/hacking_ja.html b/docs/hacking_ja.html deleted file mode 100644 index 4253188..0000000 --- a/docs/hacking_ja.html +++ /dev/null @@ -1,928 +0,0 @@ - - - - - - - - - - - - - - - CALM - Canvas Aided Lisp Magic - - -
- -

CALM をハックする

-

ビルド済みバイナリを使用

-

ステップ 1: CALM をフォークする

-

https://github.com/VitoVan/calm/fork

-

ステップ 2: CALM バイナリのインストール

-

https://github.com/VitoVan/calm#-installation

-

ステップ 3: Git リポジトリの初期化

-
# ダウンロードした CALM バイナリのディレクトリに cd する
-# 例 macOS の場合:
-cd /Applications/Calm.app/Contents/MacOS
-
-# git の init
-git init .
-
-# フォークをリモートに追加
-git remote add origin git@github.com:<your-name>/calm.git
-
-# fetch
-git fetch origin --depth=1
-
-# hard を origin/main にリセット
-git reset --hard origin/main
-

これで、修正、プッシュ、プルリクエストの作成ができるようになりましたた!

-

個人的なお気に入り

-

個人的には、リポジトリをどこか別の場所にクローンし、ダウンロードしたバイナリのディレクトリにシンボルリンクを作成します、それは次のものなどがあります:

-
cd /Applications/Calm.app/Contents/MacOS
-
-rm -rf ./build
-rm -rf ./s
-rm -rf ./src
-
-ln -s ~/github/VitoVan/calm/build build
-ln -s ~/github/VitoVan/calm/s s
-ln -s ~/github/VitoVan/calm/src src
-

これですべてのソースコードをカバーできるわけではないが、通常はこれで十分です。

-

ソースからの実行

-
    -
  1. -

    準備

    -
      -
    • -

      Linux

      -

      じっと座る。

      -
    • -
    • -

      macOS

      -

      パッケージマネージャーが必要です。Homebrew をお勧めします。

      -

      MacPortsは機能するはずですが、試してはいません。

      -
    • -
    • -

      Windows -MSYS2 をお勧めします。

      -

      Windows ユーザーに Bash を使えとは言いませんが、他の選択肢は見つかってはいません。

      -
    • -
    -
  2. -
  3. -

    SBCL と Quicklisp のインストール

    -

    SBCL のバイナリはこちらにあります。また、パッケージ・マネージャーにも含まれているはずです。簡単にインストールできるはずです。

    -
      -
    • -

      Linux (Fedora)

      -
      sudo dnf install sbcl -y
      -
    • -
    • -

      macOS

      -
      brew install sbcl
      -
    • -
    • -

      Windows

      -
      winget install sbcl
      -
    • -
    -

    SBCL をインストールしたら、ターミナルからアクセスできるはずです。

    -
    -

    Windows (MSYS2) では、次のように PATH 環境を手動で設定する必要があります:

    -
    echo 'export PATH="/c/program files/steel bank common lisp/:$PATH"' >> ~/.bashrc
    -source ~/.bashrc
    -
    -

    Quicklisp をダウンロードしてインストールする:

    -
    curl -O https://beta.quicklisp.org/quicklisp.lisp
    -sbcl --non-interactive --load quicklisp.lisp \
    -     --eval "(quicklisp-quickstart:install)" \
    -     --eval "(ql-util:without-prompting (ql:add-to-init-file))"
    -
  4. -
  5. -

    依存関係のインストール

    -

    必要なのは次のものだけです: libzstd, SDL2, SDL2_mixer, SDL2_image そして Cairo.

    -
    -

    libzstd は最近のバージョンの SBCL に必要で、SBCL をインストールすればパッケージマネージャーによって自動的にインストールされます。

    -
    -

    ここでは、いくつかのコマンドのサンプルを提供します:

    -
      -
    • Linux (Fedora) -
      sudo dnf install libzstd SDL2 SDL2_mixer SDL2_image cairo -y
      -
    • -
    • macOS -
      brew install zstd sdl2 sdl2_mixer sdl2_image cairo
      -
    • -
    • Windows (MSYS2) -
      -

      以下のコードは、ARM デバイス用に調整する必要があります。パッケージはここにある。

      -
      -
      pacman -S --noconfirm --needed git \
      - mingw64/mingw-w64-x86_64-zstd \
      - mingw64/mingw-w64-x86_64-SDL2 \
      - mingw64/mingw-w64-x86_64-SDL2_mixer \
      - mingw64/mingw-w64-x86_64-SDL2_image \
      - mingw64/mingw-w64-x86_64-cairo
      -
    • -
    -
  6. -
  7. -

    CALM をクローンし、一時的なランチャーの作成

    -
    # ソースコードのクローン
    -git clone https://github.com/VitoVan/calm.git ~/calm
    -cd ~/calm
    -
    -# 一時的なランチャーの作成
    -cat > "./calm" <<EOF
    -  cd "$HOME/calm"
    -  export CALM_APP_DIR=$(pwd)
    -  export CALM_HOME="$HOME/calm/"
    -  export CALM_CMD=show
    -  sbcl --load entry.lisp show
    -EOF
    -
    -chmod +x ./calm
    -
    -# ランチャーをPATH環境に追加
    -echo 'export PATH="$HOME/calm/:$PATH"' >> ~/.bashrc
    -
    -# Windows (MSYS2) ユーザーは、以下の行が必要な場合があります:
    -# echo 'export PATH="/mingw64/bin/:$PATH"' >> ~/.bashrc
    -
    -# ENV変更の有効化
    -source ~/.bashrc
    -
    -# 試してみる
    -calm
    -
  8. -
-

おめでとう!準備万端です!

-

何を作るのか楽しみです!

-

CALM のビルド

-

現在、CALM は GitHub actions でビルドされています。ワークフローはこちらにあります。

-

もし CALM のビルドに興味があり、何か問題が発生したら、私にお知らせください。

-

喜んでお手伝いします。

-
-
- - diff --git a/docs/installation.html b/docs/installation.html deleted file mode 100644 index 7e9ffa1..0000000 --- a/docs/installation.html +++ /dev/null @@ -1,835 +0,0 @@ - - - - - - - - - - - - - - - CALM - Canvas Aided Lisp Magic - - -
- -

CALM Installation

-

Setting Up CALM

-

You have donwloaded it, right?

-

Now let's set up the environment for the ease of use.

-
    -
  • -

    Linux

    -
    tar xvf calm.tgz --directory=$HOME/
    -echo 'export PATH="$HOME/calm/:$PATH"'>> ~/.bashrc
    -
  • -
  • -

    macOS

    -
      -
    1. -

      Open the downloaded DMG file

      -
    2. -
    3. -

      Drage the .app to the Applications folder

      -
    4. -
    5. -

      Eject the DMG and run Calm.app

      -

      It may take a while for the first run.

      -
      -

      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.

      -
      -
    6. -
    7. -

      Add command calm to the PATH environment

      -
      echo 'export PATH="/Applications/Calm.app/Contents/MacOS/:$PATH"'>> ~/.bashrc
      -
    8. -
    -
  • -
  • -

    Windows

    -
      -
    1. -

      Right click to Extract All

      -
    2. -
    3. -

      Move the extracted folder to C:\calm

      -
    4. -
    5. -

      Add C:\calm to your PATH environment variable

      -
      -

      If you are using MSYS2 or Git Bash, run the following code:

      -
      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.

      -
      -
    6. -
    -
  • -
-

Now you are all set, enjoy.

-
-
- - diff --git a/docs/installation_ja.html b/docs/installation_ja.html deleted file mode 100644 index c54e994..0000000 --- a/docs/installation_ja.html +++ /dev/null @@ -1,835 +0,0 @@ - - - - - - - - - - - - - - - CALM - Canvas Aided Lisp Magic - - -
- -

CALM インストール

-

CALM の設定

-

もうダウンロード済みですよね?

-

では、使いやすい環境を整えてみましょう。

-
    -
  • -

    Linux

    -
    tar xvf calm.tgz --directory=$HOME/
    -echo 'export PATH="$HOME/calm/:$PATH"'>> ~/.bashrc
    -
  • -
  • -

    macOS

    -
      -
    1. -

      ダウンロードした DMG ファイルを開きます

      -
    2. -
    3. -

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

      -
    4. -
    5. -

      DMG を取り出し、Calm.app を実行する

      -

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

      -
      -

      macOS の場合、Apple によって検証されていないため、システムによってソフトウェアの実行が停止される確率が非常に高いです。実行に問題がある場合は、こちらを確認してください。

      -
      -
    6. -
    7. -

      コマンド calm を PATH 環境に追加する

      -
      echo 'export PATH="/Applications/Calm.app/Contents/MacOS/:$PATH"'>> ~/.bashrc
      -
    8. -
    -
  • -
  • -

    Windows

    -
      -
    1. -

      右クリックしてすべて展開します

      -
    2. -
    3. -

      解凍したフォルダを C: に移動します

      -
    4. -
    5. -

      PATH 環境変数C:¥calm を追加します

      -
      -

      MSYS2 または Git Bash を使用している場合は、以下のコードを実行してください:

      -
      echo 'export PATH="/c/calm/:$PATH"' >> ~/.bashrc
      -
      -
      -

      Windows の場合、マイクロソフト社によって検証されていないため、システムがソフトウェアの実行を停止する確率が非常に高いです。実行に問題がある場合は、SmartScreen をバイパスする方法を見つけてください

      -
      -
    6. -
    -
  • -
-

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

-
-
- -