Libx Awesomeリスト

    このページの内容

    Awesome README

    READMEを扱う資料や関連プロジェクトをまとめたAwesomeリストです。

    例

    • Abblix/Oidc.Server - プロジェクトのバナーに情報的なバッジを配置。明確なプロジェクト説明、認証詳細を情報表で示し、ユニコードアイコンを用いる。詳細なインストールガイド、包括的なドキュメンテーションおよびスタートガイドへのリンク、ライセンス情報。テーブルオブコンテンツによる簡単なナビゲーションで、すべてのセクションに迅速にアクセス可能。
    • ai/size-limit - プロジェクトロゴ、明確な説明、スクリーンショット、ステップバイステップのインストール手順。
    • aimeos/aimeos-typo3 - プロジェクトロゴ。プロジェクトが何を実現しているかを明確に説明。デモスクリーンショット。ナビゲーションを容易にするテーブルオブコンテンツ。簡単なインストールとセットアップセクションにスクリーンショットを配置。さらに読むためのリンク。
    • alichtman/shallow-backup - プロジェクトが何を実現するかの明確な説明。GIFデモ。移動しやすい目次。バッジ。参考資料へのリンク。簡潔なインストール手順。
    • alichtman/stronghold - プロジェクトロゴ。プロジェクトが何を実現しているかの明確な説明。GIFデモ。ナビゲーションを容易にするテーブルオブコンテンツ。バッジ。さらに読むためのリンク。簡単なインストール手順。
    • amitmerchant1990/electron-markdownify - プロジェクトロゴ。極めて簡潔な説明。プロジェクトのGIFデモ。主要な機能。インストールガイド。貢献者への謝辞。
    • amplication/amplication - 明確なプロジェクトロゴ。簡潔な説明。すべての機能が説明されている。清潔なドキュメンテーション。有用なリンク（ウェブサイト、ドキュメント、ディスコード）。貢献者のリストに写真とユーザー名を含む。
    • ankitwasankar/mftool-java - プロジェクトロゴに、実現可能な成果の短い表示を加え、ナビゲーションを容易にするテーブルオブコンテンツ、重要なバッジ、清潔なインストールガイド、複数のコードサンプルを用いて機能の使い方を示す。
    • AntonioFalcaoJr/EventualShop - プロジェクトはロゴを備え、プロジェクトの情報、アーキテクチャソリューション、記事や動画、ドキュメンテーションなどの参照リンクを明確に定義している。開発環境および生産環境でのプロジェクトの実行方法を説明しており、負荷テストが記載されており、使用された技術についても説明し、アーキテクチャの図を提供している。
    • aregtech/areg-sdk - ロゴ。複数の情報および統計バッジ。貢献者およびスターを表示したリストに写真を含む。ナビゲーションを容易にするテーブルオブコンテンツと「トップへ戻る」リンク。グラフィックを含むヘッドライン。トピックの表示／非表示メニュー。プロジェクトの説明と哲学。クローンおよび統合手順。複数のツールによる迅速な構築。ツールの設定手順。例およびデモプロジェクトへの参照。使用事例への参照。ガイドおよびWikiページへの参照。連絡用のバッジ付きリンク。SNSでのプロジェクト共有用のバッジ付きリンク。
    • Armync/Arminc-AutoExec - 豊かなMarkdown機能、現代的なレイアウト、明確な説明、推奨されるコミュニティ基準への適合。
    • athityakumar/colorls - 複数のバッジ。清潔なスクリーンショット。簡単なインストール手順。ナビゲーションを容易にするテーブルオブコンテンツ。良い貢献者ガイドライン。
    • aurumz-rgb/ReviewAid - プロジェクトバナーに学術的なバッジを配置。機能アーキテクチャ図、AIプロバイダーのロゴ、折りたたみ可能なワークフロー、比較表を含む。
    • brenocq/implot3d - プロジェクトバナーにGIFを配置。オンラインデモへのリンク。複数のCIバッジ。動的に更新されるSVGで、GitHub Actionsによってリアルタイムに機能ディスカッションを反映する動的ロードマップ。最新の5つのディスカッションを表示し、クリック可能な画像で迅速にアクセス可能。清潔で構成が整ったレイアウトに、直感的なナビゲーションとスター歴史を備える。
    • ccostan/Home-AssistantConfig - プロジェクトバナー。バッジ。簡単なナビゲーション。
    • choojs/choo - バッジ、清潔で明確。折りたたみ可能な上部メニューに有用なリンクを配置。その中に主な質問に対するFAQを含む。支援者（Backers）。良い言語。
    • chroline/well_app - 目を引くプロジェクトのサムネイルと清潔なバッジ、ダウンロード情報および迅速なナビゲーションリンクを備える。複数の説明的なセクションに分かれ、各セクションには黄色のエモジを含むタイトルを設けている。プロジェクト自体、使用された技術、貢献方法についての詳細を含む。
    • CoffeeIsAllYouNeed/Invisible-Driver - シンプルなプロジェクトバナー。複数のバッジ。整理されたセクション。よくドキュメントされたプロジェクトコンポーネント（ハードウェアおよびソフトウェア）および図解。
    • create-go-app/cli - 清潔なプロジェクトロゴ。有用なバッジ（バージョン、コードスタイル、テストカバレッジ、ドキュメント）。明確なREADMEに、クイックスタート、理解しやすいインストールおよび使用手順、ビデオスクリーンキャスト、テーブルオブコンテンツに詳細に記載されたプロジェクト機能（ターミナルでの作業のデモ記録）、プロジェクトの哲学のノート（「なぜもう一つ」）、よくある質問なども含まれる。
    • Day8/re-frame - バッジ、ロゴ、TOCなど。技術の詳細、使い方、哲学、そして全体のエコシステムにおける位置づけについて、大きなよく書かれたエッセイで際立つ。
    • dbt-labs/dbt-core - プロジェクトのバナー、明確で親しみやすい説明（製品に初めて触れる人にもわかりやすい）、ツールが生成するドキュメントのスクリーンショット、そして「スタートガイド」「dbtコミュニティへの参加」「バグ報告」「コード貢献」「コードオブコンダクト」についての他の包括的なページへの簡潔なリンク
    • dmunish/notecharts - 高精度のプロジェクトバナーに、現代的なデザイナー向けのチャート例を収録したギャラリー。既存のPythonによる可視化ツールとの明確な比較と、その宣言型APIを示す簡潔なコードスニペットを含む
    • dmunish/reach - 明確な視覚的階層。HTMLとカスタムSVGアイコンを積極的に活用。バナー、アーキテクチャ図、スクリーンショットなど、豊富な画像を用いる。プロジェクトの目的、実装方法、開発計画を説明する
    • doomemacs/doomemacs - 美しく整然とした構成。中央に配置されたタイトルとセクションリンク、有用なバッジ。UIを紹介するスクリーンショット。明瞭でユーモアを交えた導入文があり、プロジェクトを完璧に表す一文に加え、「Yay Evil!」と書かれた小さな悪魔が視覚的に完成を成す。簡潔で情報量の多い機能リストに続いて、優れたインストール手順。ドキュメントや内蔵ショートカットへの助けになるリンクで締めくくっている
    • dowjones/react-dropdown-tree-select - 明確なREADMEにGIFスクリーンショットで即座にデモを示す。複数のバッジ、簡潔な目次、オンラインプレインド、ストーリーブック、詳細な説明など
    • dsplce-co/supabase-plus - よく考えられた構成。導入部分に機能の概要を簡潔に。目次。各コマンドの使用例を、親しみやすく、面白い言語で説明。各コマンドごとのセクションには、説明に合わせて機能を示す満足度の高いGIFを配置している
    • dutrevis/spark-resources-metrics-plugin - 開発者セクションにインタラクティブなMermaid図を強調し、コードアーキテクチャを示す。パッチ風のロゴ、有用なバッジ（CI、カバレッジ、バージョンリンク）、簡潔な目次を備えている。インストールセクションは、さまざまなシナリオに応じた展開可能なブロックで整理されている。使用方法セクションは現在の機能と例をカバーし、展開可能なブロックを用いている。技術バッジを含み、かつ既存の技術と今後のステップを示すセクションも備えている
    • EduardaSRBastos/my-essential-toolbox - プロジェクトスクリーンショットと情報的なバッジ。明確なプロジェクト説明。簡単なナビゲーションを可能にする目次。カテゴリごとのツールを詳細に説明する構成。パフォーマンススコアとスクリーンショット。貢献ガイドラインとライセンス情報
    • emalderson/ThePhish - プロジェクトロゴ、情報的なバッジ、有用な目次、明確な説明、スクリーンショット、ステップバイステップのインストールと設定ガイド、貢献ガイドライン、コードオブコンダクト、UML図、一貫したタグ、問題とプルリクエストテンプレート、よくドキュメント化・コメントされたコード、例
    • eylon-44/Buzz-OS - プロジェクトロゴ。カラフルなエモジ。プロジェクトのデモ、例、指示用のGIF。インストールと使用のための簡潔で即座にコピー＆ペースト可能な手順。美しく整った目次。プロジェクトの主な機能の概要を簡潔に示す
    • feberts/python-game-server - 一目でプロジェクトの内容がわかる図。開発者が必要な情報を得られるように、無駄な詳細に陥らない明確な構成のREADME。関連情報を示す選択されたバッジを配置
    • FileShot/FileShotZKE - よく考えられたセキュリティドキュメント。明確なAPIリファレンスとコード例。「キーデリバティブ」「AES-256-GCM暗号化」「アップロードパイプライン」を含む詳細な「仕組み」セクション。ブラウザ対応表とセキュリティポリシーを含む
    • github-changelog-generator/github-changelog-generator - ナビゲーションを容易にする目次。簡潔なプロジェクト説明。インストールと使用セクション。出力例。優れた機能概要。代替案のリスト。よくある質問（FAQ）
    • gitpoint/git-point - 明確な説明。プロジェクトロゴ。アプリストアロゴ。目次。きれいなスクリーンショット。機能リスト。詳細なインストールプロセス。ランディングページ
    • gofiber/fiber - きれいなプロジェクトロゴ。有用なバッジとリンク（言語切り替え、コードスタイル、テストカバレッジ、ドキュメント、Discordチャンネル）。プロジェクトの目的を明確に説明し、クイックスタート、ベンチマークチャート、詳細にドキュメント化されたコード例（長内容を隠す機能を備える）、プロジェクトの哲学的なノート（“プロジェクトの理由”）、プロジェクトのアドオンを表すテーブル、貢献者リスト、スター成長統計など、さらに多くの項目を含む
    • gowebly/gowebly - きれいなプロジェクトバナーにロゴを配置。有用なバッジとリンク（言語切り替え、テストカバレッジ、ドキュメント）。プロジェクトの目的を明確に説明し、クイックスタート、理解しやすい機能リスト、導入動画と記事へのリンク、詳細にドキュメント化されたCLIコマンド例、プロジェクトの哲学的なノート（“創造の動機”）、プロジェクトのコンポーネントを表すテーブル、アドオンとヘルパーへのリンク、スターを追加したユーザーのリストなど、さらに多くの項目を含む
    • Grigorij-Dudnik/Clean-Coder-AI - 狂ったプロジェクトプロモーション動画。美しいロゴ、説明的なモーションGIF。良いバッジ、フレームワークの仕組みを説明するスキーマ。スターを追加したユーザーのリスト。プロジェクトが何をしているかを明確に説明する
    • GTruf/Driver-Drowsiness-Detector - 美しいプロジェクトロゴ。簡潔で明瞭なプロジェクト説明。包括的な目次。機能リスト。プロジェクトスクリーンショットと動画スニペット。包括的な情報セクション。有用なリンク。プロジェクトのセットアップとビルドに向けた明確な手順。準備されたリリースの存在
    • gui-cs/Terminal.Gui - ステータスバッジ（NuGetバージョン、codecov、ダウンロード数、ライセンス）。プロジェクト名と簡潔なマルチプラットフォームタグライン。メインアニメーションに続いてプロジェクトロゴ。バージョンの呼び出しで現在のv2とv1メンテナンスラインを区別。サンプルアプリデモGIF。テンプレートインストールによるクイックスタートと実行可能なC#例。フォーム、データビュー、可視化、テキストエディタ、ファイル管理、ウィザード、マルチプラットフォームツールなど、さまざまな分野における能力をリスト化した項目。
    • GyulyVGC/sniffnet - プロジェクトバナー、カスタムバッジと水平線、簡潔な1行説明、情報的なスクリーンショット、テーブル形式のダウンロードセクションにリンク、機能のリスト、謝辞セクション、ソーシャルアイコンとリンクを含むフッター
    • haesleinhuepf/bia-bob - LLMを活用したコーディングアシスタントプロジェクトで、視覚的なデモンストレーションを極めて効果的に活用：各セクションは機能が実際に動くGIFまたはスクリーンショットで锚定され、多くの例が提供され、コピー＆ペースト可能な設定も含まれる。プロジェクトのステータスバッジと類似プロジェクトへの参照が含まれる。
    • Hexworks/Zircon - READMEにドッグフードが含まれる。プロジェクトの機能についての明確な説明。デモスクリーンショット。ナビゲーションを容易にするTOC。簡単なインストールとセットアップセクションにスクリーンショットを含む。さらに読むためのリンク。
    • hmpl-language/hmpl - プロジェクトロゴ、情報提供バッジ、明確な説明、ステップバイステップのインストール。使用コードサンプル。有用な機能。
    • htmlhint/HTMLHint - マスヘッドとして中央に配置されたヒーローアニメーション。簡潔なタグライン。有用なバッジ（npmバージョン、OpenSSFベストプラクティス、ダウンロード数、ライセンス）。迅速なナビゲーションリンク。テーブルオブコンテンツ。ローカルおよびグローバル使用を目的としたセクション別インストールガイド、ESMおよびCommonJSのコードサンプルを含む。
    • httpie/httpie - プロジェクトが何をやっているかの説明。デモスクリーンショット。プロジェクトロゴ。ナビゲーションを容易にするTOC。ビルドバッジ。簡単で迅速なインストールおよび使用セクション。例を含むセクションを提供。
    • hywax/mafl - プロジェクトロゴ。プロジェクトが何をやっているかの明確な説明。ナビゲーションを容易にするTOC。使用コードサンプル。
    • IgorAntun/node-chat - プロジェクトスクリーンショット。情報提供バッジ。明確な説明。簡単なインストール／使用手順。ライブデモ。
    • iharsh234/WebApp - プロジェクトのランディングページ。プロジェクトが何をやっているかの明確な説明。デモスクリーンショット。簡単なインストールおよび使用セクション。共通用途の例を含む例のセクションとモバイルデモセクションを提供。
    • ivanperez-keera/Yampa - 明確な説明。機能リスト。ナビゲーションを容易にするTOC。簡単なインストール手順。使用コードサンプル。プロジェクトサンプル（GIFおよびアプリストアへのリンクを含む）。ドキュメンテーションおよび出版物。明確な開発／貢献ルール。
    • karan/joe - プロジェクトロゴ。プロジェクトが何をやっているかの明確な説明。GIFデモ。簡単なインストールおよび使用セクション。
    • kopach/karma-sabarivka-reporter - プロジェクトロゴ。有用なバッジ、スクリーンショットを含む明確なREADMEで即時デモを提供。簡潔なTOC。
    • L0garithmic/FastColabCopy - プロジェクトロゴ。ミニマリズムの説明。バッジ。GIFデモ。プロジェクトについて。使い方。例。謝辞。追加例。
    • lobehub/lobe-chat - 現代的なバッジデザイン。明確な機能紹介を視覚デザイングラフィックと共に提供。エコシステムの紹介。プロジェクトの特徴および開発方法の説明。貢献者セクション。
    • lobehub/sd-webui-lobe-theme - 機能リストとデモ。i18n対応。ヘッダーおよびTOCによるナビゲーション。明確な指示。
    • ma-shamshiri/Human-Activity-Recognition - 美しいテーブルオブコンテンツ。プロジェクトロゴ。アニメーション付きプロジェクトバナー。完全なプロジェクトフォルダ構造。プロジェクトが何をやっているかの明確な説明。良い貢献者セクション。簡単なナビゲーション。
    • ma-shamshiri/Pacman-Game - 美しいテーブルオブコンテンツ。プロジェクトロゴ。アニメーション付きプロジェクトバナー。プロジェクトの各部分を表示する適切なGIF。リポジトリ内のプロジェクトファイルの完全なリストとその機能。完全な実行手順。
    • ma-shamshiri/Spam-Detector - 完全なプロジェクトファイル説明。プロジェクトロゴ。アニメーション付きプロジェクトバナー。簡潔なプロジェクト説明。明確な実行手順。
    • MananTank/radioactive-state - バッジ（バージョン、ダウンロード数、カバレッジ、サイズ）、Twitterの意図、プロジェクトロゴ、機能リスト、動機、インストール、GIF付きの例、エモジ、折りたたみ可能なセクション、ライブデモ、APIの詳細な使用方法、FAQ、チャットリンク。
    • Martinsos/edlib - 情報提供バッジ（ビルド、バージョン、公開）。簡潔な説明。機能リスト。TOC。スクリーンショット。ビルドおよびプロジェクトに組み込むための簡潔な指示と例。すぐに始められる一般的なコード例。
    • mkosir/react-parallax-tilt - GIFデモ。複数のバッジ。機能リスト。素晴らしいライブデモ（コード例付き）。ローカル開発環境のセットアップに必要な分かりやすい指示。
    • NASA/ogma - 明確な説明。機能リスト。デモGIF。簡単なインストール手順。使用コードサンプル。ナビゲーションが容易な目次。
    • nhn/tui.editor - プロジェクトロゴ。プロジェクトの機能をデモGIFで明確に説明。バッジ。ナビゲーションが容易な目次。色付きアイコンがタイトルの前。
    • NSRare/NSGIF - プロジェクトロゴ。GIFデモ。使用アートワーク。使用コードサンプル。
    • Owloops/updo - 構成が良好で、視覚的に魅力的であり、ツールの目的や機能、インストール、使用方法について、明確かつユーザーに親しみやすい形で包括的な情報を提供。
    • php-censor/php-censor - 複数のバッジ、プロジェクトロゴ、機能リスト、動画デモ、ステップバイステップのインストールおよびアップグレード手順、ナビゲーションが容易な目次。
    • PlexRipper/PlexRipper - 複数のバッジ、プロジェクトロゴ、機能リスト、説明、デモンストレーション動画、ナビゲーションが容易な目次。
    • PostHog/posthog - カスタム作成されたセクションアイコン、デモGIF、デプロイボタン、貢献者用のプロフィール画像、簡潔で明確な構成、プロジェクトロゴ。
    • priyavrat-misra/xrays-and-gradcam - ナビゲーションが容易な目次。プロジェクトの目的を明確に説明。リポジトリ内のすべてのファイルの完全なリストとその機能。使用セクション。簡潔で明確な表。
    • Rebilly/redoc - 複数のバッジ、プロジェクトロゴ、ライブデモへのリンク、主要機能のGIFアニメーション、簡潔な使用方法。
    • refinedev/refine - 清潔なプロジェクトロゴ。トップに簡潔な説明。複数のバッジ。使用方法の説明と例。使用ケースとデモリンク。スクリーンショット。主要機能。貢献者。スターガーサー。貢献ガイドライン。
    • release-it/release-it - プロジェクトの機能をデモGIFで明確に説明。バッジ。展開可能な目次。使用方法の説明と例。貢献ガイドライン。詳細なリリース情報。
    • rstacruz/hicat - GIFデモ。簡単なインストールとセットアップセクションにスクリーンショットを含む。ビルドバッジ。使用ケースの素晴らしい例。
    • ryanoasis/nerd-fonts - 清潔なプロジェクトロゴ。トップに簡潔な説明。サンキー図、クイックリンク、バッジ、OS特定アイコン、目次、詳細なリリース変更ログ。
    • sebyddd/SDVersion - プロジェクトロゴ。ビルドバッジ。複数のプログラミング言語向けのドキュメンテーション構成。使用例。
    • serpro69/kotlin-faker - プロジェクトロゴ。バッジ。簡潔な説明と明確な初めから使える手順説明（フルドキュメントサイトへのリンク）。テスト、ビルド、貢献ガイドライン。ライセンス情報。
    • shama/gaze - プロジェクトロゴ。簡潔な説明。機能リスト。使用セクション。FAQ。優れたAPIドキュメンテーション。リリース履歴。
    • shriyanyamali/JurisMercatus - プロジェクトロゴと使用方法GIF。プロジェクトの目的と開発プロセス。シンプルだが詳細なインストール手順。ライセンスと帰属に関するセクション。
    • sidneycadot/oeis - 概要。必要な依存関係のリスト。リポジトリ内のすべてのファイルの完全なリストとその機能。すべてがつながっている視覚的なグラフ。
    • sindresorhus/pageres - プロジェクトロゴ。プロジェクトが何をやっているかの明確な説明。ビルドバッジ。デモスクリーンショット。簡単なインストールと使用セクション。共通使用例を含む例のセクションを含む。
    • skydio/revup - プロジェクトロゴ。アニメーションGIFデモ＋ステップバイステップチュートリアルの主要段階へのGIF。簡潔な説明、インストール手順、貢献セクション。
    • sourcerer-io/sourcerer-app - クリーンなアニメーションスクリーンショット。カスタムなコール・トゥ・アクションバッジ。使用法のショートカット紹介。
    • sr6033/lterm - 文字で構成されたクリーンなロゴ。開発に関する簡潔な更新情報。詳細な貢献ガイドライン。貢献提案。
    • Stack-in-a-box/triumphmayflowerclub.com - 単純なウェブサイトであるにもかかわらず、経験の浅い開発者向けにオープンなプロジェクトとして提示されており、フレンドリーで包摂的なトーンとアクセスしやすいセットアップ手順が特徴。他の美しいREADMEに見られる多くの要素が含まれている。
    • stevenfoncken/multitool-for-spotify-php - 簡潔な導入説明。機能の明確な概要。なぜこのプロジェクトなのかというセクション（エイザーエッグあり）。情報提供用のバッジ。明確な免責事項。ステップバイステップのセットアップ手順。展開可能なTOC。エモジ付きの見出し。詳細な使用法セクション。トップに短リンク。フッターに「トップに戻る」リンク。第三者コード・ライブラリへの謝辞。
    • sultan99/react-on-lambda - プロジェクトロゴ、主なアイデアを漫画で表現、バッジ、コードスニペット付きの例、デモプロジェクト、APIドキュメンテーション、エディタ設定。
    • sulu/sulu - プロジェクトロゴ、有用なバッジ、さらに詳しい情報やバグ報告の場所の明確な指示、GIFスクリーンショット、エモジの良好な活用。
    • supunlakmal/thismypc - プロジェクトロゴ。有用なバッジ。ウェブサイトURL。スクリーンショット。インストール用のGIFによるステップバイステップ手順。プロジェクトフォルダ構成。
    • teles/array-mixer - クリーンなプロジェクトロゴ、バッジ。目次。貢献セクション。多くの図解例。
    • thelounge/thelounge - プロジェクトロゴ。有用なバッジとリンク（ウェブサイト、ドキュメント、デモ）。スクリーンショット。機能リスト。インストール、開発、テストのステップバイステップ手順。貢献ガイドへのリンク。モバイル向けの良好な要約。
    • themerdev/themer - プロジェクトロゴ。プロジェクトが実行する内容を視覚的に説明（フローチャート）。ビルドバッジ。目次。デモスクリーンショット。簡潔なインストンールおよび使用法セクション、一般的なワークフローを含む。カラフルなプレビュー。
    • treeverse/dvc - ReStructuredText形式の例、PyPi対応。ロゴ、カスタムなウェブサイト風メニュー。スムーズな「どうやって動くか」アニメーション。バッジ。良好な貢献セクションに「名門」の項目を含む。
    • vhesener/Closures - プロジェクトロゴ、認知フンネル、アニメーション例。色分けされたデザイン。クリーンなドキュメンテーション。
    • voltagent/voltagent - クリーンなプロジェクトロゴ。有用なバッジとリンク（ウェブサイト、ドキュメント、デモ）。スクリーンショット。機能リストの中の明確なコード例。クイックスタート例。
    • xnbox/DeepfakeHTTP - オリジナルのヒーローセクション。明確なナビゲーション。ミニマリズム設計。付録。
    • yeaight7/awesome-ai-devtools - 構造化されたメタデータから自動生成されたREADME。カスタムSVGヘッダー、比較マトリクス、カテゴリインデックス、ツールテーブル、レビューに基づく要約を含む。
    • yvann-ba/ft_transcendence - ミニマリズムなプロジェクトバナー、テーブルレイアウトの明確なGIFギャラリー。カラフルなアーキテクチャ図。明確な技術スタック説明。貢献者アバターを含むチームセクション。
    • zenml-io/zenml - クリーンなプロジェクトロゴ。有用な目次。機能リストの中の明確なコード例。クイックスタート例。

    アーキテクチャの例

    A good ARCHITECTURE.md file helps developers understand how and where to make changes, whether they are new to a project or not.

    Diagrams, source code maps, and discussing invariants and design decisions are essential.

    This can also be a dedicated section of your README.md files.

    • esbuild - グラフィックの良好な活用により、視覚化やプロジェクト構造を表現。プロジェクトの重要な原則のリストを含む。
    • Flutter Engine - 高レベルの図を用いてスタックとその部分を示す。主なプロセスを説明。プラットフォームの不変性を説明。
    • GitLab - 設計決定を明確に指摘。
    • Linux cryptography - 異なる種類のコンポーネントを呼び出し、検索可能な領域を提供し、各コンポーネントの不変性を指摘し、構造を図で説明する。
    • Neovim - 主なプロセス／ライフサイクルを説明する。
    • Oh My Zsh - 初期化プロセスを説明し、環境要件を指摘する。
    • Redis - 良いソースコードマップ。重要なファイルの概要。コード内にドキュメントコメントを適切に活用している。
    • Tauri - 良好なソースコードマップで、アーキテクチャの考慮事項を議論し、重要な依存関係を指摘している。
    • VS Code - 高レベルの図を適切に活用。ソースコードの組織構造を説明している。

    記事

    プレゼンテーション

    • “Build a Better README” - Jason A. Crome が 2024年 ナッシュビル、アメリカ合衆国で開催された The Perl and Raku Conference で発表。

    ツール

    • Amazing GitHub Template - ユーティリティな README.md、LICENSE、CONTRIBUTING.md、CODE_OF_CONDUCT.md、SECURITY.md、GitHubのイシュー、プルリクエストおよびアクションテンプレートを活用してプロジェクトをスムーズにスタート。
    • Common Readme - Node向けの一般的なREADMEスタイル。ガイドとREADME生成ツールを含む。
    • Github Licenses Stats - このツールは、GitHubリポジトリで使用されているトップのライセンスを動的にSVGで表示する。
    • GitHub PR Stats - GitHubプルリクエストを動的に表示するカスタマイズ可能なSVGテーブル。詳細なPRリストとリポジトリの集計統計の2モードを提供。ステータスフィルタ、スターに基づくソート、カスタマイズ可能なフィールドを備える。
    • GitHub Readme Stats - READMEに動的に生成されたカスタマイズ可能なGitHubカード。統計情報、追加ピン、トップ言語、WakaTimeを含む。
    • GPRM - GitHub プロフィール README を現代的な UI で生成するツール
    • Hall-of-fame - リポジトリの貢献者への認知を表示するためのツール。新規・トレンド・トップ貢献者を表示。1時間ごとに更新。
    • Make a README - README を書くためのガイド。編集可能なテンプレートとリアルタイム Markdown レンダリングを含む。
    • README best practices - あなたの README.md をコピー＆ペーストできる場所
    • Readme Forge - コンポーネントベースの README 生成ツールで、すばらしい README を簡単に作成。豊富で柔軟な README テンプレートライブラリを備える。
    • readme-md-generator - CLI で美しい README.md ファイルを生成
    • README Typing SVG - 動的に生成され、カスタマイズ可能な SVG で、テキストの入力と削除の様子を再現。プロフィール README に最適。
    • READMINE - ソフトウェアプロジェクト用の詳細で明確かつ自己説明的な README ファイルテンプレート。必要に応じてコピーして編集できる。
    • StackEdit - プロジェクトの README に必要なすべてのセクションを簡単にカスタマイズできる、使いやすいオンラインエディタ。
    • Standard Readme - 標準的な README スタイルの仕様。仕様に準拠した README を作成するための生成ツールも備える。
    • Telegram Card - Telegram チャンネル、グループ、ボット向けの動的プレビューカード生成ツール。レスポンシブデザイン、ダーク/ライトテーマ対応、サブスクリバー／メンバー／月間ユーザー／オンラインユーザー数を表示。GitHub プロフィールやポートフォリオに最適。
    • user-statistician - GitHub プロフィール README に、詳細な GitHub ユーザー活動の SVG を生成する GitHub Action
    • Zalando’s README Template - すべての基本をカバーするためのシンプルテンプレート。

    GIFの作成

    READMEにアニメーションGIFを埋め込むと、プロジェクトの動作をすぐに示して読者の目を引けます。プロジェクト用のGIFを手早く作成できるプログラムを紹介します。

    • Gifski - 無料 - 他のものよりも鮮やかな色を提供しながら、サイズは小さく保つ。
    • Giphy Capture - 無料 - giphy.com へのアップロードが簡単だが、やや不快な UX を持つ。
    • LICEcap - 無料 - より直感的ではないが、機能が豊富。
    • ScreenToGif - 無料 - オープンソース。カスタマイズ可能なUIと編集しやすいGIFを備え、簡単に使い始められます。
    • terminalizer - 無料 - テーマを記録し、アニメーション GIF またはウェブプレイヤーを生成・共有できる。
    • ttystudio - 無料 - コマンドラインツール向け。ターミナルからGIFを記録できます。
    • vhs - 無料 - シンプルなスクリプト言語で、美しいターミナルGIFを生成します。

    フィードバックを得る

    • maintainer.io - READMEの標準化とフィードバックを無料で提供します。「Book an audit」をクリックしてください。

    貢献

    貢献はいつでも歓迎します。 最初にコントリビューションガイドラインをお読みください。

    ライセンス

    CC0

    法律で認められる範囲で、Matias Singers は本作品に関するすべての著作権および関連する権利を放棄しています。