Skip to content

Commit

Permalink
[feat] Zoltraakプロジェクトの紹介セクションをREADMEに追加
Browse files Browse the repository at this point in the history
README.mdにZoltraakプロジェクトの詳細な説明を追加しました。この変更により、Zoltraakの目的と機能が利用者に対してより明確に伝わります。

- 「Introduction」セクションを「Zoltraakとは」に変更
- Zoltraakの概要とその特徴を簡潔に説明
- プロジェクトの利用方法と環境構築の手順を追記
  • Loading branch information
Maki committed Apr 27, 2024
1 parent 5338897 commit b08871d
Showing 1 changed file with 27 additions and 77 deletions.
104 changes: 27 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,3 @@
---
title: HarmonAI II
emoji: 🌖
colorFrom: purple
colorTo: gray
sdk: streamlit
sdk_version: 1.33.0
app_file: app.py
pinned: false
license: mit
---


<p align="center">
<img src="https://media.githubusercontent.com/media/Sunwood-ai-labs/HarmonAI/main/docs/icon/icon2.gif" width="100%">
<br>
Expand All @@ -36,87 +23,50 @@ license: mit
>[!IMPORTANT]
>このリポジトリは[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage)を活用しており、リリースノートやREADME、コミットメッセージの9割は[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage)[claude.ai](https://claude.ai/)で生成しています。
## 🌟 Zoltraakとは

## 🌟 Introduction

HarmonAI IIは、AIとの調和と無限の可能性を追求するプロジェクトです。このリポジトリは、HarmonAI IIの開発テンプレートとして機能し、以下のような特長を備えています:

### 1. 開発スピードの向上
- GitHub ActionsとHugging Faceの連携による自動デプロイ
- 定型的な設定ファイル(.gitignore, .SourceSageignoreなど)の事前準備

### 2. リポジトリの品質向上
- 豊富なバッジによるプロジェクト情報の見える化
- 体系的に整えられたREADMEテンプレート
- SourceSageによるAI支援でのコミットメッセージ、リリースノート生成

このテンプレートを活用することで、リポジトリ作成時のイニシャルコストを下げつつ、品質と開発速度を担保することができます。AI時代の開発スタイルを先取りした、生産性の高いテンプレートとしてご利用ください。

## 🎥 Demo

HarmonAI IIのデモアプリケーションは、GitHub Actionsと連携し、自動的にデプロイされています。デモアプリを体験することで、HarmonAI IIの機能を直感的に理解することができます。

[![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/MakiAi/zoltraak_docker)
**Zoltraak(ゾルトラーク)** は、自然言語(日本語)で様々なタスクを依頼することができる、革新的なプログラミングツールです。
システム開発、ホームページ制作、デザイン、分析など、短い文章で依頼するだけで必要な資料やソースコードを生成してくれます。

## 🚀 Getting Started
従来の対話型AIとは一線を画し、シンプルかつパワフルな問題解決を実現。
プログラミングの知識がなくても、アイデアを具現化できる魔法のようなツールです。

### Installation
このリポジトリでは、DockerでかんたんにZoltraakを利用する環境を提供しています。

HarmonAI IIのインストール手順は以下の通りです:
## 🚀 はじめに

1. リポジトリをクローンします: `git clone https://github.com/Sunwood-ai-labs/zoltraak_docker.git`
2. 必要な依存関係をインストールします: `pip install -r requirements.txt`
### 事前準備

### Usage
- Docker、docker-composeのインストール
- [ANTHROPIC](https://www.anthropic.com/) でAPIキーを取得し、 `.env` ファイルに設定

HarmonAI IIの使用方法は以下の通りです:
`.env` ファイルにANTHROPICのAPIキーを設定:

```bash
git lfs install
git lfs track "*.png"
git lfs track "*.gif"
git lfs track "*.jpeg"
git lfs track "*.jpg"
git lfs track "*.mp4"
```

リポジトリ名を適切に変更してください:

```bash
run: git push --force https://MakiAi:$HF_TOKEN@huggingface.co/spaces/MakiAi/zoltraak_docker main
ANTHROPIC_API_KEY=sk-ant-XXXXXXXXXXX
```

### Customization

HarmonAI IIは、ユーザーのニーズに合わせてカスタマイズ可能です。設定ファイルを編集することで、プロジェクトの動作を柔軟に調整できます。

## 📝 Updates

- v1.1.0 (2024-04-24):
- フロントページの作成
- READMEの全体的な改善
- GitHub Actionsを使用したHuggingFace hubへの自動シンク機能の追加
- .gitignoreと.SourceSageignoreの更新
- プロジェクト名を「HarmonAI」から「zoltraak_docker」に変更
- v1.0.0 (2024-04-20):
- 初回リリース
- 基本的な機能を実装
### 起動方法

```bash
# イメージのビルドとコンテナ起動
docker-compose up --build

## 🤝 Contributing
# コンテナ内でbashを起動
docker-compose exec app /bin/bash

HarmonAI IIへのご協力は大歓迎です!バグ報告、機能要求、プルリクエストなどを通じて、プロジェクトの改善にご協力ください。詳細は[CONTRIBUTING.md](CONTRIBUTING.md)をご覧ください。
# Zoltraakを実行
zoltraak "mp4からgifを作成するstremlitのアプリを作成したい" -c dev_obj
```

## 📄 License
## 🙌 コントリビューション

HarmonAI IIは[MIT License](LICENSE)の下でリリースされています
IssueやPull Requestは大歓迎です。改善案や機能追加のアイデアがありましたらぜひお寄せください

## 🙏 Acknowledgements
## 📄 ライセンス

HarmonAI IIの開発にあたり、以下の方々に感謝いたします:
Zoltraak DockerはMITライセンスの下で公開されています。

- [Sunwood-ai-labs](https://github.com/Sunwood-ai-labs)チームのメンバー
- [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage)プロジェクト
- [claude.ai](https://claude.ai/)チーム
## 🙏 謝辞

引き続き、HarmonAI IIプロジェクトをよろしくお願いいたします!
Zoltraakを開発している [元木大介さん(@ai\_syacho)](https://twitter.com/ai_syacho) に深く感謝いたします。

0 comments on commit b08871d

Please sign in to comment.