Help us understand the problem. What is going on with this article?

cargo publish する前に埋めておきたい Cargo.toml の項目に関するメモ

正直試行錯誤しないと https://crates.io 挙動が良くわからんかったのでメモを書いておく。

name, version, authors, edition の4つは cargo new の際にでデフォルトで書かれる。

[package]
name = "hoge"
version = "0.1.0"
authors = ["Hideyuki Tanaka <tanaka.hideyuki@gmail.com>"]
edition = "2018"

licenselicense-file の項目は必須。所定のコードを入れるか、license-file にライセンスファイルのファイル名を入れる。

ライセンスのコードは https://spdx.org/licenses/Identifier の項目を入れれば多分良いはず。

license = "MIT"
# または
license-file = "LICENSE"

description と (repository または homepage) も(多分)必須。
repositoryhomepage はあれば http://crates.io のパッケージのページにリンクが張られる。
最初は repository だけで、万が一パッケージが成長して公式ページができたら homepage に書けば良いのでは。

description = "Hoge library"
repository = "https://github.com/tanakh/hogehoge"
homepage = "..."

documentation のURLもパッケージのページからリンクが張られるが、この項目がない場合、自動生成された https://docs.rs のドキュメントへのリンクが自動的にパッケージのリンクに貼られるので、よほどこだわりがないかドキュメントの自動ビルドに失敗するような場合以外は空にしておいた方が良いのでは。

documentation = "..."

readme にパッケージ内へのファイル名を指定しておけば、それをパッケージのページの "About This Package" みたいなところにレンダリングしてくれる(とりあえずMarkdownはしてくれた)。正直これがあるとないとでは見栄えが全然違うのでこれは指定しておいた方が良いと思う。

readme = "README.md"

categorieskeywords は埋めておくとページにそれぞれカテゴリーとキーワードへのリンクを付けてくれる。
パッケージを見つけてもらいやすくなるんだと思う。

categories の方は https://crates.io/categories/ の中から選択で、keywords は好きな単語を書けば良いんじゃないかと思う(https://crates.io/keywords の人気の高いのを書くと見つけられやすくなるのかも知れない)。

categories = ["algorithms"]
keywords = ["graph"]

まとめ

cargo publish するときに設定しておいた方が良い項目のまとめ:

[package]
# `cargo new` が自動生成するやつ
name = "..."
version = "..."
authors = ["..."]
edition = "2018"

# `cargo publish` するときに最初から埋めて置いた方が良い項目
description = "..."
repository = "<url-to-repository>"
license = "MIT" # <https://spdx.org/licenses/> から選択
readme = "README.md"

# お好みで
categories = ["..."] # <https://crates.io/categories/> から選択
keywords = ["..."]

# あれば
homepage = "<url-to-homepage>"

# デフォルトで docs.rs へのリンクが作られるからあまり要らないのでは
documentation = "<url-to-documentation>"
tanakh
Haskellプログラマです。
http://tanakh.jp
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした