これは「SATySFi Advent Calendar 2020」の25日目の記事です。
24日目はmonaqaさんによる「今年作ったパッケージを振り返る」でした。
21日目のgfnさんの記事がまだ出ていないですが、一応25日目を迎えることができましたね!(遅刻しましたが……)
SATySFi Advent Calendarは今年で3回目となります。 参加してくださった多くの方々に感謝いたします。
さて、今回は「learn-satysfi」を紹介しようと思います。
(本当は12月中に中身をもっと充実させるつもりだったのですが、精神状態が悪くなって記事が全く書けてませんでした)
目標
これは「SATySFiを学ぶためのドキュメント」というコンセプトのもと作っている文書です。
GitHub上で公開し、作成を行っています。リポジトリは「puripuri2100/learn-satysfi」です。
starを押していただけるとモチベーションが上がります。
この文書はRustのThe Rust Programming Languageのようなものを目指しています。
- メンテナンスがしっかりとされており、最新版の情報をしっかり記述する
- 本当の初心者が文書やパッケージを作れるようになる知識を提供する
- 言語の詳しめな部分まで踏み込んで解説する
を一つの目標としています。
また、現在は日本語で書いていますが、将来的にはこれらを翻訳して英語版も作りたいと思っています。
執筆方法
原稿はMarkDownで書いています。
Rust製のソフトウェアであるmdbookを用いることでこれらの原稿をHTMLファイルに変換し、ブラウザで見ることができるようになります(使わなくても普通のMarkDownとして読み書きできます)。
リポジトリをforkして変更を加え、プルリクエストを送っていただければ取り込みますので、積極的に送っていただけると嬉しいです。
今後について
現在執筆は途中までしか進んでいませんので、記事を充実させていきたいと思います。