Update README.md
Browse files
README.md
CHANGED
@@ -8,9 +8,9 @@ pinned: false
|
|
8 |
---
|
9 |
# ArtyLLaMA: Empowering AI Creativity in the Open Source Community π¦π¨
|
10 |
|
11 |
-
ArtyLLaMA is an innovative chat interface for Open Source Large Language Models,
|
12 |
|
13 |
-
##
|
14 |
|
15 |
ArtyLLaMA is not a model itself, but a framework that allows users to interact with various language models through Ollama. It provides a user-friendly interface for generating creative content, code, and visualizations using state-of-the-art language models.
|
16 |
|
@@ -48,25 +48,25 @@ Users of ArtyLLaMA should be aware of:
|
|
48 |
|
49 |
## Technical Specifications
|
50 |
|
51 |
-
- **Framework**:
|
52 |
-
- **Required Libraries**:
|
53 |
- **Supported Model Formats**: Those supported by Ollama
|
54 |
- **Hardware Requirements**: Varies based on the chosen model size
|
55 |
|
56 |
## Getting Started
|
57 |
|
58 |
-
1. Clone the repository: `git clone https://github.com/kroonen/ArtyLLaMA`
|
59 |
-
2.
|
60 |
-
3.
|
61 |
-
4.
|
62 |
-
5. Run the application: `
|
63 |
-
6. Access the interface at `http://localhost:
|
64 |
|
65 |
For more detailed instructions and documentation, visit our [GitHub repository](https://github.com/kroonen/ArtyLLaMA).
|
66 |
|
67 |
## License
|
68 |
|
69 |
-
ArtyLLaMA is distributed under the
|
70 |
|
71 |
## Citation
|
72 |
|
@@ -85,7 +85,7 @@ If you use ArtyLLaMA in your research or projects, please cite it as follows:
|
|
85 |
|
86 |
For questions, feedback, or collaborations, please reach out to:
|
87 |
- GitHub: [https://github.com/kroonen/ArtyLLaMA](https://github.com/kroonen/ArtyLLaMA)
|
88 |
-
- Email:
|
89 |
- Twitter: [@rob_x_ai](https://x.com/rob_x_ai)
|
90 |
|
91 |
-
We welcome contributions and feedback from the community!
|
|
|
8 |
---
|
9 |
# ArtyLLaMA: Empowering AI Creativity in the Open Source Community π¦π¨
|
10 |
|
11 |
+
ArtyLLaMA is an innovative chat interface for Open Source Large Language Models, leveraging the power of Ollama. It features dynamic content generation and display through an "Artifacts-like" system, making AI-assisted creativity more accessible and interactive.
|
12 |
|
13 |
+
## Project Description
|
14 |
|
15 |
ArtyLLaMA is not a model itself, but a framework that allows users to interact with various language models through Ollama. It provides a user-friendly interface for generating creative content, code, and visualizations using state-of-the-art language models.
|
16 |
|
|
|
48 |
|
49 |
## Technical Specifications
|
50 |
|
51 |
+
- **Framework**: React-based frontend, Node.js backend
|
52 |
+
- **Required Libraries**: React, Express.js, Tailwind CSS, Three.js
|
53 |
- **Supported Model Formats**: Those supported by Ollama
|
54 |
- **Hardware Requirements**: Varies based on the chosen model size
|
55 |
|
56 |
## Getting Started
|
57 |
|
58 |
+
1. Clone the repository: `git clone https://github.com/kroonen/ArtyLLaMA.git`
|
59 |
+
2. Install dependencies: `npm install`
|
60 |
+
3. Ensure Ollama is installed and running on your system
|
61 |
+
4. Set up environment variables (see README for details)
|
62 |
+
5. Run the application: `npm run dev`
|
63 |
+
6. Access the interface at `http://localhost:3000`
|
64 |
|
65 |
For more detailed instructions and documentation, visit our [GitHub repository](https://github.com/kroonen/ArtyLLaMA).
|
66 |
|
67 |
## License
|
68 |
|
69 |
+
ArtyLLaMA is distributed under the ArtyLLaMa Research Project License. This license allows free use for non-commercial, academic, and research purposes with attribution. Commercial use requires explicit written permission. See the [LICENSE](https://github.com/kroonen/ArtyLLaMA/blob/main/LICENSE) file for full details.
|
70 |
|
71 |
## Citation
|
72 |
|
|
|
85 |
|
86 |
For questions, feedback, or collaborations, please reach out to:
|
87 |
- GitHub: [https://github.com/kroonen/ArtyLLaMA](https://github.com/kroonen/ArtyLLaMA)
|
88 |
+
- Email: robin@kroonen.ai
|
89 |
- Twitter: [@rob_x_ai](https://x.com/rob_x_ai)
|
90 |
|
91 |
+
We welcome contributions and feedback from the community, subject to the terms of our license!
|