Maki commited on
Commit
b224f0e
1 Parent(s): d548a30

[docs] READMEの改善

Browse files

- プロジェクトの概要と主な特徴を追加
- インストール手順を詳細に記述
- 使い方の説明を追加
- ドキュメント、コントリビューション、ライセンス、お問い合わせについての情報を追加
- バッジのリンクを修正し、バッジのラベルを改善
- Markdownの書式を整えて読みやすくした

Files changed (1) hide show
  1. README.md +58 -5
README.md CHANGED
@@ -1,3 +1,4 @@
 
1
  <p align="center">
2
  <img src="https://media.githubusercontent.com/media/Sunwood-ai-labs/SlideNova/develop/docs/SlideNova_icon.png" width="100%">
3
  <br>
@@ -5,17 +6,69 @@
5
  <h3 align="center">
6
  ~Experience Slide-Making Reinvented~
7
 
8
- [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/Sunwood-ai-labs/SlideNova)[![](https://img.shields.io/github/stars/Sunwood-ai-labs/SlideNova)](https://github.com/Sunwood-ai-labs/SlideNova)[![](https://img.shields.io/github/last-commit/Sunwood-ai-labs/SlideNova)](https://github.com/Sunwood-ai-labs/SlideNova)[![](https://img.shields.io/github/languages/top/Sunwood-ai-labs/SlideNova)](https://github.com/Sunwood-ai-labs/SlideNova)[![GitHub Release](https://img.shields.io/github/v/release/Sunwood-ai-labs/SlideNova?sort=date&color=red)
9
- ](https://github.com/Sunwood-ai-labs/SlideNova)
 
 
 
10
  </h3>
11
-
12
  </p>
13
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  ```bash
15
- npx slidev slides/demo.md --remote
16
  ```
17
 
 
 
18
  ```bash
19
- npx slidev export slides/demo.md --format png --output slides/out/ --dark -t
20
  ```
21
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
  <p align="center">
3
  <img src="https://media.githubusercontent.com/media/Sunwood-ai-labs/SlideNova/develop/docs/SlideNova_icon.png" width="100%">
4
  <br>
 
6
  <h3 align="center">
7
  ~Experience Slide-Making Reinvented~
8
 
9
+ [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/Sunwood-ai-labs/SlideNova)
10
+ [![GitHub Stars](https://img.shields.io/github/stars/Sunwood-ai-labs/SlideNova)](https://github.com/Sunwood-ai-labs/SlideNova)
11
+ [![GitHub Last Commit](https://img.shields.io/github/last-commit/Sunwood-ai-labs/SlideNova)](https://github.com/Sunwood-ai-labs/SlideNova)
12
+ [![GitHub Top Language](https://img.shields.io/github/languages/top/Sunwood-ai-labs/SlideNova)](https://github.com/Sunwood-ai-labs/SlideNova)
13
+ [![GitHub Release](https://img.shields.io/github/v/release/Sunwood-ai-labs/SlideNova?sort=date&color=red)](https://github.com/Sunwood-ai-labs/SlideNova)
14
  </h3>
 
15
  </p>
16
 
17
+ ## 🚀 はじめに
18
+
19
+ SlideNovaは、Markdownからモダンで美しいスライドを簡単に作成できるWebアプリケーションです。
20
+ [Slidev](https://sli.dev/)を使用しており、スライドの生成はDockerコンテナ内で行われます。
21
+ Streamlitを使用した直感的なユーザーインターフェイスで、Markdownを入力するだけですぐにスライドを作成できます。
22
+
23
+ ## 🌟 主な特徴
24
+
25
+ - 📝 Markdownでスライド作成
26
+ - 🎨 Slidevを使用したモダンなスライドデザイン
27
+ - 🐳 Dockerによる環境構築の簡易化
28
+ - 🖥️ Streamlitによる使いやすいWebUI
29
+
30
+ ## 📦 インストール
31
+
32
+ SlideNovaを使用するには、DockerとDocker Composeが必要です。以下の手順に従ってください。
33
+
34
+ 1. このリポジトリをクローンします。
35
+
36
+ ```bash
37
+ git clone https://github.com/Sunwood-ai-labs/SlideNova.git
38
+ ```
39
+
40
+ 2. プロジェクトディレクトリに移動します。
41
+
42
  ```bash
43
+ cd SlideNova
44
  ```
45
 
46
+ 3. Docker Composeを使用してSlideNovaを起動します。
47
+
48
  ```bash
49
+ docker-compose up --build
50
  ```
51
 
52
+ 4. ブラウザで `http://localhost:8502` を開きます。
53
+
54
+ ## 🛠️ 使い方
55
+
56
+ 1. Markdownエディタにスライドのコンテンツを入力します。
57
+ 2. 「Generate Slides」ボタンをクリックします。
58
+ 3. 生成されたスライドが表示されます。
59
+
60
+ ## 📖 ドキュメント
61
+
62
+ より詳細な情報は、[ドキュメント](docs/)を参照してください。
63
+
64
+ ## 🤝 コントリビューション
65
+
66
+ コントリビューションは歓迎します!詳細は[コントリビューションガイド](CONTRIBUTING.md)を参照してください。
67
+
68
+ ## 📜 ライセンス
69
+
70
+ このプロジェクトは[MITライセンス](LICENSE)の下で公開されています。
71
+
72
+ ## 📧 お問い合わせ
73
+
74
+ ご質問やご提案がありましたら、[Issue](https://github.com/Sunwood-ai-labs/SlideNova/issues)を作成してください。