Skip to content

Commit 668fd48

Browse files
authored
Update README (#1155)
* Update README.md * Add files via upload * Update README.md
1 parent 08ba7b6 commit 668fd48

File tree

2 files changed

+77
-42
lines changed

2 files changed

+77
-42
lines changed

README.md

Lines changed: 77 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,97 @@
1-
# Learn Prompting
1+
<p align="center">
2+
<img width="100%" src="https://github.com/kavaivaleri/Learn_Prompting/blob/main/astronaut_welcome.webp" alt="Learn Prompting, astronaut">
3+
</p>
24

3-
[![Twitter](https://img.shields.io/twitter/url?label=Follow%20%40learnprompting&style=social&url=https%3A%2F%2Ftwitter.com%2Flearnprompting)](https://twitter.com/learnprompting)
5+
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Awesome%20Prompting%20Resources%20-%20a%20collection%20of%20awesome%20lists%20related%20to%20prompt%20engineering%20by%20@learnprompting&url=https://github.com/trigaten/Learn_Prompting) [![Twitter](https://img.shields.io/twitter/url?label=Follow%20%40learnprompting&style=social&url=https%3A%2F%2Ftwitter.com%2Flearnprompting)](https://twitter.com/learnprompting)
46
[![](https://dcbadge.vercel.app/api/server/7enStJXQzD?compact=true&style=flat)](https://discord.gg/7enStJXQzD)
57
![Website](https://img.shields.io/website?down_message=offline%20%3A%28&up_message=learnprompting.org&url=https%3A%2F%2Flearnprompting.org)
68

9+
<h1 align="center">
10+
<strong>Learn Prompting — Your Go-To Resource for Mastering Generative AI</strong>
11+
</h1>
12+
<p align="center">
13+
Learn prompt engineering and generative AI with our free resources, courses, and on-demand webinars.
714

8-
[https://learnprompting.org](https://learnprompting.org)
15+
<p align="center">
16+
<strong>
17+
<a href="https://learnprompting.org/">Website</a> • <a href="https://discord.com/invite/learn-prompting-1046228027434086460">Discord</a> • <a href="https://x.com/learnprompting">Twitter (X)</a> • <a href="https://www.linkedin.com/company/learn-prompting/">LinkedIn</a> • <a href="https://learnprompting.beehiiv.com/subscribe">Newsletter</a> • <a href="https://learnprompting.org/courses/chatgpt-for-everyone">Free ChatGPT Course</a> • <a href="https://learnprompting.org/docs/introduction">Free Prompt Engineering Guide</a> • <a href="https://learnprompting.org/courses">Course Catalog</a> • <a href="https://learnprompting.org/contact-sales">Book a Demo</a> • <a href="mailto:[email protected]">Contact us</a>
918

10-
Prompt Engineering, Generative AI, and LLM Guide by Learn Prompting | Join our discord for the largest Prompt Engineering learning community
19+
</strong>
20+
</p>
1121

12-
## Contribution Guidelines
22+
## What is Learn Prompting?
23+
The **Learn Prompting** team are creators of:
24+
- The [free Prompt Engineering Guide](https://learnprompting.org/docs/introduction), cited by OpenAI and Google.
25+
- [15 courses on Generative AI](https://learnprompting.org/courses) to help you develop cutting-edge AI skills.
26+
- [On-demand workshops and training](https://learnprompting.org/for-business) for individuals and businesses.
27+
- [HackAPrompt](https://www.hackaprompt.com/), the largest AI red-teaming competition ever.
1328

14-
We welcome contributions in any form.
29+
## 📢 Announcements and Updates
1530

16-
We are actively looking for:
31+
- 🏆 **[HackAPrompt 2.0](https://www.hackaprompt.com/)** is here with **$500,000 in prizes** and 5 exciting tracks! [Join the waitlist](https://docs.google.com/forms/d/e/1FAIpQLScWexmVn_BWYhBsfZY7udh-iM8j2ZVyEoFLt3xhVVxP4gKFHA/viewform) and learn more in this [article](https://learnprompting.org/blog/announce-hackaprompt-2).
32+
- 🎓 We’ve launched a cohort-based **AI Red Teaming and AI Safety course**! [Enroll here](https://maven.com/learn-prompting-company/ai-red-teaming-and-ai-safety-masterclass).
33+
- 💼 Our team has hosted workshops at OpenAI, Microsoft, Deloitte, Dropbox, and more. [Contact us](https://learnprompting.org/for-business) for custom solutions.
1734

18-
- content suggestions
19-
- translation
20-
- content/art contributions
21-
- typos :)
35+
### Learn Prompting Research
36+
- **[The Prompt Report: A Systematic Survey of Prompting Techniques](https://trigaten.github.io/Prompt_Survey_Site/)** ([blog post](https://learnprompting.org/blog/the_prompt_report)): The most comprehensive study of prompting techniques to date.
37+
- **[Ignore This Title and HackAPrompt: Exposing Systemic Vulnerabilities of LLMs](https://arxiv.org/abs/2311.16119):** Insights from analyzing over 600K adversarial prompts across state-of-the-art LLMs.
2238

39+
---
2340

41+
## 🚀 Contribution Guidelines
2442

25-
## Local Development
26-
27-
First, install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [node](https://nodejs.org/en/download/).
28-
29-
Make sure you are using Node 18.0.0 or higher (`node -v`). Then, run the following commands in a terminal:
30-
```
31-
# download the website code with git
32-
git clone https://github.com/trigaten/Learn_Prompting.git
33-
# enter the project directory
34-
cd Learn_Prompting
35-
# install node modules
36-
npm i
37-
# run the website locally
38-
npm start
39-
```
43+
We welcome contributions of all kinds! Here’s how you can help:
4044

41-
If you get an error related to the node version, you probably are using an older version of node.
45+
- Suggest new **content** ideas or improvements.
46+
- **Translate** resources into other languages.
47+
- Contribute **artwork** or additional resources.
48+
- Help fix **typos** or improve clarity.
4249

43-
Make sure the newer version appears higher in your path than any older versions.
50+
Every contribution is appreciated, no matter how big or small! ❤️
4451

45-
Alternatively, you can use [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) to install the latest version of node. Install nvm, then do the following:
46-
```
47-
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
48-
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
49-
nvm install-latest-npm
50-
```
51-
52-
53-
`npm start` starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
54-
55-
## Thanks to all contributors ❤
52+
## Local Development
5653

57-
<a href = "https://github.com/trigaten/Learn_Prompting/graphs/contributors">
58-
<LazyLoadImage src = "https://contrib.rocks/image?repo=trigaten/Learn_Prompting"/>
59-
</a>
54+
### First Steps
55+
Before you start, ensure you have the following installed:
56+
- **[Visual Studio Code](https://code.visualstudio.com/)**
57+
- **[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)**
58+
- **[Node.js](https://nodejs.org/en/download/)** (version **18.0.0** or higher, `node -v`)
59+
60+
If you're on macOS or Linux, you can use **[Homebrew](https://brew.sh/)**, a package manager, to install the necessary tools.
61+
62+
To begin:
63+
1. Clone the repository from GitHub:
64+
```bash
65+
git clone https://github.com/trigaten/Learn_Prompting_nextjs.git
66+
```
67+
2. Navigate to the project folder:
68+
```bash
69+
cd Learn_Prompting_nextjs
70+
```
71+
72+
### Run the Website Locally
73+
Once the setup is complete, you can run the website locally to preview your changes:
74+
75+
1. Ensure you are using Node.js version **18.0.0** or higher:
76+
```bash
77+
node -v
78+
```
79+
2. Install the required Node.js modules:
80+
```bash
81+
npm install
82+
```
83+
3. Run the website in development mode:
84+
```bash
85+
npm run dev
86+
```
87+
88+
This will start a local development server, and your changes will be reflected live in the browser.
89+
90+
## ❤️ A Huge Thanks to All Contributors
91+
We’re grateful for all the amazing contributions from our community! 🙌
92+
Check out our contributors below:
93+
94+
<p align="center"> <a href="https://github.com/trigaten/Learn_Prompting/graphs/contributors"> <img src="https://contrib.rocks/image?repo=trigaten/Learn_Prompting" alt="Contributors"> </a> </p>
6095

6196
## Cite
6297

astronaut_welcome.webp

97.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)