Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README #20

Merged
merged 11 commits into from
Feb 26, 2023
Merged

update README #20

merged 11 commits into from
Feb 26, 2023

Conversation

kmuto
Copy link
Collaborator

@kmuto kmuto commented Feb 25, 2023

README書き中です

  • argsの対応が必要そう
  • MIB、子フォルダは掘らないですよね(掘る必要性もないと思います)
  • インストール、実行のあたりがどう書こうかちょっとあやふや
  • 起動の自動化についてはsystemd serviceファイルを用意しようと思います。args待ち
  • copyrightホルダーはysetoさんでよいかなと
  • 英語は日本語が固まったらREADME_ja.mdにしてから作ろうかなと思っています

@yseto
Copy link
Owner

yseto commented Feb 25, 2023

MIB、子フォルダは掘らないですよね(掘る必要性もないと思います)

はい、子フォルダは掘らないです。

インストール、実行のあたりがどう書こうかちょっとあやふや

レポジトリ上で、tagを打つとバイナリをGitHub Releasesに置く。みたいな仕組みを使うと、開発環境がなくても使えるようになって敷居が下がるので、そういう仕組みを検討するといいですかね。

copyrightホルダーはysetoさんでよいかなと

kmutoさんのエッセンスも入っているので、よろしければ追加いただけるとよいと思っています。

@kmuto
Copy link
Collaborator Author

kmuto commented Feb 26, 2023

@yseto
READMEひとまず作りました。
インストールのところは、今はこの手順(go install)だと動かないのと、sabatrapd.ymlなどの置き場所は?という問題がありました。
systemdブランチのほうでMakefileを用意したので、git releaseについてがんばることがなければmakeしてねだけでもよいかもしれません。

@kmuto kmuto requested a review from yseto February 26, 2023 07:42
@kmuto kmuto changed the title [WIP] update README update README Feb 26, 2023
@yseto
Copy link
Owner

yseto commented Feb 26, 2023

ありがとうございます。

設定ファイルが必要なので、go installだけでは先に進めず、難しさが残る形にはなってしまいますね。
このREADMEを読んでいて、GitHub Releasesにビルド済みのバイナリは用意したいと思いました。その成果物内にsystemdファイルなどを入れたりしたいですね。パッケージ内への同根は調べてはいないですが簡単にできるはず。という認識です。

@kmuto
Copy link
Collaborator Author

kmuto commented Feb 26, 2023

Releasesでのバイナリ配布は今後のWISHLISTとして、ひとまず現状合わせで Gitワーキングフォルダからのインストールでの手法に書き換えました。

Copy link
Owner

@yseto yseto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ありがとうございます。丁寧に進めていただき感謝です。

@kmuto kmuto merged commit 7faf2e8 into main Feb 26, 2023
@kmuto kmuto deleted the update-readme branch February 26, 2023 12:59
@kmuto
Copy link
Collaborator Author

kmuto commented Feb 26, 2023

だいぶプロダクトっぽくなりましたね!

@kmuto kmuto mentioned this pull request Feb 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants