読みやすいREADMEを書く | Yakst

2016/06/22 951 users Yakst ドキュメント 筆者 ウェブサイト 唯一

いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウ... 続きを読む

Git の diff を美しく表示するために必要なたった 1 つの設定 #git - 詩と創作・思索のひろば (Poetry, Writing and Contemplation)

2013/11/26 669 users contrib pager Poetry gitconfig

2013-11-26 Git の diff を美しく表示するために必要なたった 1 つの設定 #git Git Git に同梱されている contrib/diff-highlight を使います。 あとは README に書いてあることの引き写しですが、PATH の通ったディレクトリに置いて、~/.gitconfig に以下のように設定を書く。 [pager] log = diff-highlig... 続きを読む

文章作成やメモ書きにも便利、Markdown記法｜Web Design KOJIKA17

2013/01/23 648 users markdown記法 メモ書き 文章作成 tumblr CMS

HTMLは、手軽なマークアップ言語ですが、開始タグや終了タグなどあり、文章作成やちょっとしたメモ書きには不向きです。 今回紹介するのは、Markdownという軽量なマークアップ言語です。 GitHubのREADMEや、Tumblrなどでも採用されており、様々なCMSのプラグインも存在しています。 汎用性が高く便利な記法なので紹介します。 Markdownとは Markdown は、文書を記述するた... 続きを読む

README のファイル名が大文字である理由 - clock-up-blog

2014/05/09 432 users README.md GitHub readme.txt 慣習

2014-05-08 README のファイル名が大文字である理由 慣習 文字コード README のファイル名は慣習的にすべて大文字（であることが多い） GitHub でプロジェクトを作るときに README を作成するオプションを入れておくと、README.md というファイルができる。それ以外の場所のプロジェクトでも README.txt や README など、ファイル名がすべて大文字にな... 続きを読む

‘-‘ という名前の、中身が無いのに70万回ダウンロードされてる謎のnpmパッケージ – 秋元@サイボウズラボ・プログラマー・ブログ

2021/08/03 403 users 秋元@サイボウズラボ npmパッケージ プログラマー 中身

– という名前の JavaScript/TypeScript パッケージについて警告を発している記事が話題となっています。 このパッケージ、中身はほとんど空で、Readme と、dev で TypeScript を動かせるようにするライブラリ群を呼ぶ箇所だけのもの。 しかし、この “-” を使っている他の npm パッケージが 50個以上あり、約一年前の公開... 続きを読む

GitHubのREADMEをサクッと高品質で書けるサービス作ってみました。 - Qiita

2020/08/23 332 users GitHub Qiita OSS みなさん タイトル

みなさんは GitHub でオープソースソフトウェア(OSS)を開発して公開する時、README をどのように書いているでしょうか？ GitHub が自動で作ってくれる README に含まれるのはタイトルだけですし、OSS 開発初心者の場合、そもそも README に何を含めるべきかわからないという方もいらっしゃるのではないでしょうか？OSS ... 続きを読む

自作 OSS のためのロゴを作る | micnncim

2019/12/08 277 users micnncim Description OSS リーチ デモ

著名 OSS にあって自作 OSS に無いものの一つにロゴがあります。 OSS において README の出来不出来はユーザへのリーチを高める重要な要素であり、詳細な Description や GIF によるデモはもちろん、ロゴがあればより魅力的な README になるでしょう。 また、SNS でシェアされる際もロゴがあればより良いでしょう。 はじ... 続きを読む

OCR処理プログラム及び学習用データセットの公開について | NDLラボ

2022/04/25 244 users NDLラボ GitHub NDLOCR OCR ライセンス

2022年04月25日 NDLラボのGitHubから、次の2件を公開しました。ライセンスや詳細については、各リポジトリのREADMEをご参照ください。 NDLOCR 国立国会図書館（以下、「当館」とします。）が令和3年度に株式会社モルフォAIソリューションズに委託して実施したOCR処理プログラムの研究開発事業の成果である、日本語のOCR... 続きを読む

GitHubで「Deep Running」というREADMEだけのリポジトリを作ったら奇跡が起こった - karaage. [からあげ]

2021/08/19 240 users ツボ パワーワード 分身ロボットカフェ KARAAGE 元記事

「Deep Running」が産まれた日 もう元記事は消えてしまったのですが、なんか的はずれだなーと個人的に感じた「分身ロボットカフェ」を批判する記事がありました。記事の内容はどうでも良いのですが（すでに忘れました）。その記事にあった「ディープランニング」というパワーワードがみょうにツボに入ってしまいました。... 続きを読む

Rails Hub情報局: ついに軽量Rubyの「mRuby」のソースコードが公開！

2012/04/20 237 users mruby レポジトリ 軽量Ruby 生みの親 Ruby

Rubyの生みの親、まつもとゆきひろさんが、ついに新しいRuby実装である「mRuby」のソースコードをGitHub上で公開しました！ 2012年4月20日です。ライセンスは、MITライセンスとなっています。公開されたレポジトリから、Readmeの一部を引用します。 mRubyはISO規格に準拠したRuby言語を様々な環境で動作可能となるように軽量化したものです。モジュール構成によりインタプリタ実... 続きを読む

Ruby - Webスクレイピングライブラリ "Yasuri" をリリースしました - Qiita

2015/05/05 232 users Qiita Usage ゴマン Ruby GitHub

はじめに こんにちは．私はWebスクレイピングが大好きなのですが、Rubyでもっと簡単にスクレイピングができればと思い、ライブラリを書いてみました． ようやくREADMEとUSAGEが書けたので公開しようと思います． ソースはGithubで公開しています． 特にドキュメントの英語が大変怪しいので、つっこみいただけると喜びます． tac0x2a/yasuri gemでも公開しているので、以下のコマン... 続きを読む

Rust + Yew = WebAssembly でかんばんライクなタスク管理アプリを作ってみました。 | ヌーラボ

2019/01/24 206 users yew htm ELM rust React

Rust + Yew = WebAssembly でかんばんライクなタスク管理アプリを作ってみました。 YewはRustで書かれたフロントエンド向けのフレームワークです。 書かれたコードはWebAssemblyに変換されて、ブラウザ上で実行することができます。プロジェクトのREADMEに「ElmとReactに影響を受けた」と書かれているように、JSX風のHTM... 続きを読む

統計的自然言語処理エンジンStaKK - nokunoの日記

2010/11/23 175 users nokuno GitHub Mozc サジェスト http

統計的自然言語処理エンジンStaKK を開発しました。nokuno’s stakk at master - GitHub 以下、READMEからの引用です。 現在の機能 かな漢字変換 予測変換 または サジェスト スペル訂正 形態素解析 HTTPによるAPIサーバ Trieの直接操作現在は、StaKK は辞書として Mozc （Google日本語入力のOSS版）のデータを使っています。 リバースモ... 続きを読む

Kibana 3 + Rails + Fluentdのサンプルアプリを作ってみた - y_310's diary

2013/09/11 168 users サンプルアプリ Rails fluentd Kibana 動作

2013-09-11 Kibana 3 + Rails + Fluentdのサンプルアプリを作ってみた miyagawaさんのPodcast Rebuild: 19でKibanaの話があってちょっと盛り上がり始めてるので、簡単に動作を試せるサンプルアプリセットを作ってみました。 https://github.com/y310/kibana-trial git cloneしてREADMEに書いてある... 続きを読む

CoreOS - はじめてのRocket - Qiita

2014/12/05 166 users Rocket Qiita CoreOS インストー めんどい

先日、CoreOS がRocketというコンテナ実行エンジンを発表して話題になりますた。 Rocketを少し触ってみたので簡単なまとめを書いておこうと思います。 チュートリアル 簡単にRocketでコンテナ起動までをやってみましょう。 簡単にREADMEに目を通しておくことをすすめます。 今回はfilesetを作るのがめんどいのでDockerコンテナを流用します。 そのためDockerをインストー... 続きを読む

(新人)エンジニアが開発しやすいREADMEの書き方

2023/06/29 165 users Zenn コラボイベント 登壇スライド エンジニア 新人

2023年6月28日に開催された「Findy×freee」さんのコラボイベントに登壇した「新人エンジニアが入っているプロジェクトにおけるREADMEの書き方」の登壇スライドです エンジニアが開発しやすい環境作りをする(Zenn) 続きを読む

よくないねボタン - Qiita

2016/12/04 150 users Qiita support ガイドライン 半分 Google

いいね だけじゃ　だめなんだよ。 良い記事を書くためのガイドライン - Qiita:Support こういうガイドラインがあるけども、これに沿った良い記事なんて半分もないんだよ。 質問の場所と勘違いしている記事や、READMEを貼り付けただけの記事、ブックマークサービスとしてURL貼るだけの記事ばかり。 Googleで「あれどうやるんだっけ」と調べるとトップにQiitaが出てきて開いてみると、 「... 続きを読む

Goのクリーンアーキテクチャで参考になりそうなもの

2023/04/15 146 users クリーンアーキテクチャ リポジトリ 参考 モチベーション 観点

はじめに Goでクリーンアーキテクチャっぽく実装したいモチベーションがあり、そのためにはコードを読むのが一番だと思ったので、参考にしていったリポジトリをまとめてみます。 観点としては スター数が比較的多いもの（400以上） READMEにアーキティクチャについての考えが明記されているもの を中心にピックアップし... 続きを読む

自律型AIソフトウェアエンジニア「Devin」登場。Readmeを読んで環境構築、Print文を使ってデバッグなど

2024/03/14 129 users cognition コードエディタ Devin デバッグ 登場

自律型AIソフトウェアエンジニア「Devin」登場。Readmeを読んで環境構築、Print文を使ってデバッグなど AIスタートアップのCognitionが自律型のAIソフトウェアエンジニア「Devin」を発表した。Devinは人間と同様にコードエディタやコンソール、Webブラウザを用いて情報を参照し、コーディングやデバッグ作業を自律的に行... 続きを読む

良質なAPIドキュメンテーションと共にAPI利用者のためのデベロッパハブも提供するReadMe - TechCrunch

2015/03/14 94 users ドキュメンテーション TechCrunch デベロッパ 企業

Y Combinatorで孵化したReadMeは、デベロッパ向けにAPIを提供している企業が、APIの良質なドキュメンテーションを容易に作れるようにしてくれる。 今はほとんどのサービスがAPIを公開しているから、それらを利用すれば自分が作るアプリケーションやサービスに高度な機能を簡単に実装できる。でも、APIをデベロッパにぜひ使っていただきたい、と願っている企業から見ると、そこにはデベロッパたちの... 続きを読む

mitukiii.jp | Rubyでコマンドラインスクリプト書くならThorが便利そう

2011/06/01 93 users thor コマンドラインツール GitHub 意訳 Ruby

経緯 PadrinoというRuby製のWebフレームワークのジェネレータ周りのコード読んでるとThorというライブラリでタスクが書かれていました。コードがエレガントで読みやすかったので調べてみました。 Thorとは GithubのREADMEのDescriptionより意訳。 wycats/thor – GitHub Thorは自己ドキュメント化されたコマンドラインツールを効率よく作るツールです。... 続きを読む

GitHubのREADMEの見た目をイケてる感じにする

2022/11/21 92 users GitHub リポジトリ ご存知 見た目 プロフィール

どうも、hanetsukiです。 GitHubにはアカウントそれぞれにREADMEを乗せられるリポジトリがついているのはご存知でしょうか？ 以前から簡易的なプロフィールは掲載していたのですが、訪問していただいた方に「おっ！」っと思わせるようなREADMEにしたいと思い更新することにしました。 今回更新するにあたって何を使った... 続きを読む

Google+ 非公式 API で情報を取得するPHPライブラリを使ってみた - Shin x blog

2011/07/27 83 users PHPライブラリ GitHub Shin x blog 設定

まだ登場していない Google+ の API ですが、非公式な API を利用して情報を取得するライブラリがあったので使ってみました。 Google+のストリーム で教えて頂いた php-googleplusapi というライブラリで github で公開されています。 はじめは README に従って、MySQL の設定などしたのですが、Google+ から情報を取得するだけなら、DB の設定... 続きを読む

Zsh - コマンドパスを自動で通し npm install -g しない - Qiita

2015/01/26 78 users package.json コマンドラインツール リポジトリ

npm install -g cosidered harmful 何かコマンドラインツールなどが必要なために npm install -g を強要するリポジトリがたまにある。 もっと面倒なのは、依存するツールがあるくせに README とかに書いてない場合だ。リポジトリにある設定ファイルからこちらが察して入れてやらないといけない。 グローバルに入れるツールは package.json の管理外なの... 続きを読む

おそらくはそれさえも平凡な日々: Perl製のWebアプリケーションをherokuで3分で動かすの法

2013/05/21 61 users Heroku miyagawa Perl製 cpanm 日々

PSGIアプリなら簡単にherokuで動かせます。 Miyagawaさんのbuildpack(https://github.com/miyagawa/heroku-buildpack-perl)を 使います。使い方もREADMEに書いてあったけど、以下にも書きます。 アプリ側の準備 deployしたいアプリケーションのgitリポジトリ上で以下をやります。 cpanm --installdeps .... 続きを読む