add readme and license

2 files changed, 34 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..2d1fdf8
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2024 nsfisis
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9ed9069
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Albatross.PHP
+
+
+## これは何？
+
+2024-03-07 から 2024-03-09 にかけて開催された [PHPerKaigi 2024](https://phperkaigi.jp/2024/) の中のコードゴルフ企画にて使用されたシステムのソースコードです。
+
+現在は回答を締め切っていますが、ゴルフの問題や開催中の参加者の方々の回答は、以下のページから閲覧できます。
+
+https://t.nil.ninja/phperkaigi/2024/golf/
+
+
+## おおまかな動作の仕組み
+
+本システムは、以下二つのコンポーネントからなります。
+
+* [services/app/](./services/app/): [Slim Framework](https://www.slimframework.com/) で書かれたアプリケーションサーバ
+* [services/sandbox-exec/](./services/sandbox-exec/): WebAssembly を使ったサンドボックス実行環境
+
+コードゴルフの回答が期待する動作をしているかどうか検証するには、入力されたコードを実際に実行してみる必要があります。任意のコードを自由に実行させてしまうと、深刻な脆弱性に繋がってしまいます。
+
+このシステムでは、環境の隔離に WebAssembly を用いています。具体的には、PHP の処理系を [Emscripten](https://emscripten.org/) を用いて WebAssembly に変換し、その上で入力された PHP コードを動かしています。PHP 処理系を WebAssembly へとコンパイルする部分については、[以前にブログ記事にまとめていますので、そちらをご参照ください](https://blog.nsfisis.dev/posts/2023-10-02/compile-php-runtime-to-wasm/)。
+
+
+## ライセンス
+
+このリポジトリ中のファイルには、[services/app/assets/favicon.svg](./services/app/assets/favicon.svg) を除いて、The MIT License が適用されます。ライセンス表記については [LICENSE](./LICENSE) をご覧ください。