Skip to content

Commit 53dcc10

Browse files
committed
docs: update License for devkit components and realign doc (#847)
1 parent e5ea90b commit 53dcc10

File tree

4 files changed

+37
-56
lines changed

4 files changed

+37
-56
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright (C) 2025 Intel Corporation
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 33 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,43 @@
11

22
# Edge Developer Kit Reference Scripts
33

4+
This repository provides simplified developer kit reference setup scripts for various Intel® platforms and GPUs.
45

5-
**Transform your Intel® hardware into a powerful AI and edge computing platform in minutes, not hours.**
6-
7-
8-
Whether you're an ODM/OEM developer, AI/ML engineer, university student, or hardware enthusiast, this repository provides everything you need to unlock the full potential of Intel®'s latest processors and GPUs.
9-
6+
> **First time:** Follow our [detailed setup guide](./docs/getting-started.md) for a guided experience.
107
11-
This repository provides simplified developer kit reference setup scripts for various Intel® platforms and GPUs.
8+
-> **Quick Start:** Get running in 5 minutes with our [one-line installer](#5-minute-quick-start).
129

13-
> **⚡ Quick Start:** Get running in 5 minutes with our [one-line installer](#-5-minute-quick-start)
10+
> **Note:** The main branch contains the latest development version of the project. It may include experimental features, work in progress, or unstable code.
1411
15-
> **🚧 Note:** The main branch contains the latest development version of the project. It may include experimental features, work in progress, or unstable code.
12+
- Officially Supported: Ubuntu 24.04 LTS (tested on `Ubuntu 24.04.3 LTS`) with the 6.14 HWE kernel (for example `6.14.0-33-generic`).
13+
- Kernel / HWE Guidance: The setup and reference scripts are validated against the Ubuntu 24.04 HWE stack (Linux 6.14). We recommend using the HWE kernel matching the tested version for best compatibility and to avoid driver/packaging mismatches.
1614

17-
## 🎯 Who Is This For?
15+
## Who Is This For?
1816

1917
| **Your Background** | **What You'll Get** | **Start Here** |
2018
|-------------------|-------------------|----------------|
21-
| 🏭 **ODM/OEM Developer** | Production-ready platform setup with validated hardware configurations | [Hardware Setup Guide](#-validated-hardware--configurations) |
22-
| 🤖 **AI/ML Developer** | Ready-to-use AI workloads: LLMs, computer vision, speech processing | [AI Use Cases](#-ai--ml-use-cases) |
23-
| 🎓 **Student/Researcher** | Learning-oriented tutorials with step-by-step explanations | [Learning Path](./docs/getting-started/README.md) |
24-
| 🔧 **Hardware Enthusiast** | Experiment with cutting-edge Intel® hardware and software | [Quick Start](#-5-minute-quick-start) |
19+
| 🏭 **ODM/OEM Developer** | Production-ready platform setup with validated hardware configurations | [Hardware Setup Guide](#validated-hardware-configurations) |
20+
| 🤖 **AI/ML Developer** | Ready-to-use AI workloads: LLMs, computer vision, speech processing | [AI Use Cases](./docs/use-cases.md) |
21+
| 🎓 **Student/Researcher** | Learning-oriented tutorials with step-by-step explanations | [Learning Path](./docs/getting-started.md) |
22+
| 🔧 **Hardware Enthusiast** | Experiment with cutting-edge Intel® hardware and software | [Quick Start](#5-minute-quick-start) |
2523
| 🏆 **ESQ Users** | System validation and certification for hardware qualification | [ESQ Overview](https://github.com/open-edge-platform/edge-system-qualification)|
2624

2725

28-
## 🚀 5-Minute Quick Start
29-
30-
**Just bought an Intel® developer kit?** Get up and running immediately:
26+
## 5-Minute Quick Start
3127

3228
```bash
33-
# One command to rule them all
3429
sudo bash -c "$(wget -qLO - https://raw.githubusercontent.com/intel/edge-developer-kit-reference-scripts/refs/heads/main/main_installer.sh)"
35-
```
3630

37-
> **First time?** → Follow our [detailed setup guide](./docs/getting-started.md) for a guided experience.
31+
```
3832

39-
### 🚀 **Next Steps**
33+
### Next Steps
4034

4135
1. **Explore all use cases** from [our gallery](./docs/use-cases.md)
4236
2. **Discover more ingredients** in [Open Edge Platform Software Catalog](https://edgesoftwarecatalog.intel.com/) and [Open Edge Platform GitHub*](https://github.com/open-edge-platform)
4337
3. **Join the community** on [GitHub* Discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions)
4438
4. **Share your projects** and help others learn!
4539

46-
## 📋 Table of Contents
47-
48-
- [🎯 Who Is This For?](#-who-is-this-for)
49-
- [🚀 5-Minute Quick Start](#-5-minute-quick-start)
50-
- [💻 Validated Hardware & Configurations](#-validated-hardware--configurations)
51-
- [🤖 AI & ML Use Cases](./docs/use-cases.md)
52-
- [❓ Need Help?](#-need-help)
53-
- [⚠️ Important Notes](#️-important-notes)
54-
55-
## 💻 Validated Hardware & Configurations
40+
## Validated Hardware & Configurations
5641

5742
| Product Collection | Code Name | Support | Validated Hardware |
5843
|--------------|--------------|-------------------|--------------------|
@@ -79,43 +64,39 @@ The following table lists the validated hardware combinations using Developer Ki
7964
| **Raptor Lake (RPL)** | Arc B60 (dGPU) | ✅ Supported |
8065

8166

82-
## ❓ Need Help?
67+
## Community and Support
8368

69+
If you need help, want to suggest a new feature, or report a bug, use the following channels:
8470

85-
### 🚑 **Quick Solutions**
86-
- **Installation Issues?**[Troubleshooting Guide](./docs/troubleshooting.md)
87-
- **Common Questions?**[FAQ](./docs/faq.md)
88-
- **Community Support?**[GitHub* Discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions)
89-
90-
### 📞 **Get Support**
91-
| Issue Type | Where to Go |
92-
|------------|-------------|
93-
| **Bug Reports** | [GitHub* Issues](https://github.com/intel/edge-developer-kit-reference-scripts/issues) |
94-
| **Feature Requests** | [GitHub* Discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions) |
95-
| **General Questions** | [Community Forum](https://community.intel.com/) |
71+
- **Installation Issues**[Troubleshooting Guide](./docs/troubleshooting.md)
72+
- **Common Questions**[FAQ](./docs/faq.md)
73+
- **Community Support**[GitHub* Discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions)
74+
- **Bug Reports**[GitHub* Issues](https://github.com/intel/edge-developer-kit-reference-scripts/issues)
75+
- **Feature Requests**[GitHub* Discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions)
76+
- **General Questions**[Community Forum](https://community.intel.com/)
9677

9778

9879
---
9980

100-
## ⚠️ Important Notes
81+
## Important Notes
10182

10283

103-
### 🛡️ **Development Status**
84+
### Development Status
10485
This repository contains pre-production code and is intended for testing and evaluation purposes only. The code and features provided here are in development and may be incomplete, unstable, or subject to change without notice. Use this repository at your own risk.
10586

10687
The reference scripts provided in this repository have been validated and tested on the hardware listed in the documentation. While we strive to ensure compatibility and performance, these scripts may not function as expected on other hardware configurations. Users may encounter issues or unexpected behavior when running the scripts on untested hardware. If you encounter any issues or have suggestions for improvements, we welcome you to open an issue.
10788

108-
### 📄 **License Notes**
89+
### License Notes
10990

110-
- **GStreamer*:** LGPL licensed - you're responsible for additional licenses if needed → [Learn more](https://gstreamer.freedesktop.org/documentation/frequently-asked-questions/licensing.html)
111-
- **Intel* Components:** Check individual component licenses in installation logs
91+
The Edge Developer Kit Reference Scripts project and its components is licensed under the [APACHE 2.0](./LICENSE) license, except for the following components:
11292

113-
### 🤝 **Contributing**
114-
We welcome contributions! Check our [Contributing Guide](./CONTRIBUTING.md) to get started.
115-
116-
---
93+
| Component | License |
94+
|:----------|:--------|
95+
| Real Time | BSD-3-Clause |
96+
| GStreamer | [LGPL](https://gstreamer.freedesktop.org/documentation/frequently-asked-questions/licensing.html) |
11797

11898

119-
**🎉 Ready to start building amazing AI applications with Intel® hardware? Let's go!**[Choose your first project](./docs/use-cases.md)
99+
### Contributing
100+
We welcome contributions! Check our [Contributing Guide](./CONTRIBUTING.md) to get started.
120101

121102
---

usecases/ai/edge-ai-demo-studio/frontend/src/components/samples/digital-avatar/avatar-stream.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export function AvatarStream({
6262

6363
if (turnServerIp) {
6464
config.iceServers.push({
65-
urls: [`turn:${turnServerIp}`],
65+
urls: [`stun:${turnServerIp}`],
6666
username: 'dummy',
6767
credential: 'dummy',
6868
})

usecases/ai/edge-ai-demo-studio/frontend/src/components/workloads/lipsync/settings.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,10 +183,10 @@ export function SettingsModal({
183183
<DeviceSelector />
184184
<div className="space-y-2">
185185
<Label htmlFor="turn-server-ip" className="text-base font-medium">
186-
TURN Server IP
186+
STUN/TURN Server IP
187187
</Label>
188188
<p className="text-sm text-gray-500">
189-
Enter TURN server IP address with port for remote access
189+
Enter STUN/TURN server IP address with port for remote access
190190
(optional, e.g., 192.168.1.100:3478 or turn.example.com:3478)
191191
</p>
192192
<Input

0 commit comments

Comments
 (0)