Skip to content

Commit

Permalink
add README&LICENSE (close #8)
Browse files Browse the repository at this point in the history
  • Loading branch information
monaqa committed Dec 14, 2019
1 parent 3b6ab94 commit e95f30d
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 1 deletion.
7 changes: 7 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright (c) 2019 Mogami Shinichi

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.
54 changes: 54 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
SLyDIFi
#######

SLyDIFi は, `SATySFi <https://github.com/gfngfn/SATySFi>`_ でスライドを作成するためのパッケージ(クラスファイル)です.
LaTeX でいうところの beamer に相当しています(機能は本当に最低限のものしかありませんが).

Installation & Usage
====================

以下,SATySFi が手元の環境にインストールされていることを前提とします.
クラスファイル作成者の限られた環境下でしか試していませんが,
以下の手順を踏めばだいたい動くのではないかと思います.

1. ``~/.satysfi/dist/packages/`` 以下に本リポジトリをクローン
(ディレクトリ名を ``slydifi`` とする)

2. 適当なディレクトリ下で,以下のように記述された ``minimum.saty`` を用意::

@require: slydifi/slydifi

Slydifi.document(|
draft-mode = false;
fonts = (|
frame-title-cjk = `mplus-sans-b`; % 自分が持っているフォントに変える
normal-text-cjk = `mplus-sans-r`; % 自分が持っているフォントに変える
frame-title-latin = `mplus-sans-b`; % 自分が持っているフォントに変える
normal-text-latin = `mplus-sans-r`; % 自分が持っているフォントに変える
mono-text-latin = `mplus-mono-r`; % 自分が持っているフォントに変える
font-ratio-cjk = 1.0;
|);
|)'<
+frame{\SLyDIFi; のテスト}<
+p{Hello, \SATySFi; and \SLyDIFi;!}
>
>

3. これで以下のような PDF が生成されたら,正常に動いています.

.. image:: fig/slydifi-test.png

SLyDIFi でできること
====================

タイトルスライド,セクションスライド,通常のスライドを作成することができます.
スライド内では,段落,箇条書き,図表の挿入,脚注の挿入を行うことができます.
インラインテキストマークアップとして,最低限必要と思われる ``\textbf``, ``\emph``, ``\link`` を用意しています.

ToDo
====

* `satyrographos <https://github.com/na4zagin3/satyrographos>`_ への対応
* オーバーレイ(アニメーション)機能
* テーマのカスタマイズ機能

Binary file added fig/slydifi-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion slydifi.satyh
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ type imginfo =
| Shift of length * length * imginfo % (x-shift , y-shift) * imginfo
| Phantom of imginfo

let-inline ctx \SLyDiFi =
let-inline ctx \SLyDIFi =
let size = get-font-size ctx in
let f = read-inline ctx in
let fd = ctx |> set-manual-rising (0pt -' (size *' 0.25)) |> read-inline in
Expand Down

0 comments on commit e95f30d

Please sign in to comment.