cmagganas commited on
Commit
047ca1c
1 Parent(s): e9f9e26

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +56 -6
README.md CHANGED
@@ -8,10 +8,60 @@ pinned: false
8
  license: mit
9
  ---
10
 
11
- # build-advisor
12
- an ai app that helps guide ai developers to build their ai apps
13
 
14
- ```
15
- pip install -r requirements.txt
16
- chainlit run app.py -w
17
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  license: mit
9
  ---
10
 
11
+ # Welcome to Build Advisor! 🛠️✨
 
12
 
13
+ Build Advisor is an AI app designed to help guide AI developers in building their AI applications. With Build Advisor, you can:
14
+
15
+ - **Create a plan:** Get a structured plan for your AI project.
16
+ - **Generate product requirement specifications:** Define the necessary specifications to build your app.
17
+ - **Implement solutions:** Quickly create a Proof of Concept (PoC) to evaluate your ideas.
18
+
19
+ ### Why Use Build Advisor?
20
+
21
+ - **Determine project worth:** Assess whether your idea is worth starting, investing time, and investing money.
22
+ - **Leverage AI expertise:** Utilize LLMs and effective prompt engineering for optimal results.
23
+
24
+ ### Getting Started
25
+
26
+ 1. **Install dependencies:**
27
+
28
+ ```bash
29
+ pip install -r requirements.txt
30
+ ```
31
+
32
+ 2. **Run the application:**
33
+
34
+ ```bash
35
+ chainlit run app.py -w
36
+ ```
37
+
38
+ ### Features and Roadmap
39
+
40
+ #### Current Version (v1)
41
+
42
+ - **Deploy on HF spaces:** Make your project accessible on Hugging Face spaces.
43
+ - **Landing Page Intro:** Include an introduction: "I am... I do... how to use me..."
44
+
45
+ #### Week 2 (W2)
46
+
47
+ - **Work with SME:** Get a few-shot examples (3+) for each agent:
48
+ - Definition agent
49
+ - Specification agent
50
+ - **PDF Output:** Create and manage PDF outputs:
51
+ - Open PDF view
52
+ - Download PDF
53
+ - Feedback box for user input (good/bad, suggestions for changes)
54
+ - **Iteration:** Work section-by-section with saved states for feedback-based modifications.
55
+
56
+ ### Business Value: 🚦Green Light Projects
57
+
58
+ - **v1**
59
+ - **Definition (What?):** Product Requirement Definition
60
+ - **Specification (How?):** Engineering/Function
61
+
62
+ - **v2**
63
+ - **Plan (When? Who?):** Resource Allocator
64
+
65
+ ---
66
+
67
+ We hope Build Advisor helps streamline your AI development process! Happy building! 🚀😊