Skip to content

Commit

Permalink
Update README (trigaten#1155)
Browse files Browse the repository at this point in the history
* Update README.md

* Add files via upload

* Update README.md
  • Loading branch information
kavaivaleri authored Jan 14, 2025
1 parent 08ba7b6 commit 668fd48
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 42 deletions.
119 changes: 77 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,97 @@
# Learn Prompting
<p align="center">
<img width="100%" src="https://github.com/kavaivaleri/Learn_Prompting/blob/main/astronaut_welcome.webp" alt="Learn Prompting, astronaut">
</p>

[![Twitter](https://img.shields.io/twitter/url?label=Follow%20%40learnprompting&style=social&url=https%3A%2F%2Ftwitter.com%2Flearnprompting)](https://twitter.com/learnprompting)
[![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)
[![](https://dcbadge.vercel.app/api/server/7enStJXQzD?compact=true&style=flat)](https://discord.gg/7enStJXQzD)
![Website](https://img.shields.io/website?down_message=offline%20%3A%28&up_message=learnprompting.org&url=https%3A%2F%2Flearnprompting.org)

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

[https://learnprompting.org](https://learnprompting.org)
<p align="center">
<strong>
<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>

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

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

We welcome contributions in any form.
## 📢 Announcements and Updates

We are actively looking for:
- 🏆 **[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).
- 🎓 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).
- 💼 Our team has hosted workshops at OpenAI, Microsoft, Deloitte, Dropbox, and more. [Contact us](https://learnprompting.org/for-business) for custom solutions.

- content suggestions
- translation
- content/art contributions
- typos :)
### Learn Prompting Research
- **[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.
- **[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.

---

## 🚀 Contribution Guidelines

## Local Development

First, install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [node](https://nodejs.org/en/download/).

Make sure you are using Node 18.0.0 or higher (`node -v`). Then, run the following commands in a terminal:
```
# download the website code with git
git clone https://github.com/trigaten/Learn_Prompting.git
# enter the project directory
cd Learn_Prompting
# install node modules
npm i
# run the website locally
npm start
```
We welcome contributions of all kinds! Here’s how you can help:

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

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

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:
```
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
nvm install-latest-npm
```


`npm start` starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Thanks to all contributors ❤
## Local Development

<a href = "https://github.com/trigaten/Learn_Prompting/graphs/contributors">
<LazyLoadImage src = "https://contrib.rocks/image?repo=trigaten/Learn_Prompting"/>
</a>
### First Steps
Before you start, ensure you have the following installed:
- **[Visual Studio Code](https://code.visualstudio.com/)**
- **[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)**
- **[Node.js](https://nodejs.org/en/download/)** (version **18.0.0** or higher, `node -v`)

If you're on macOS or Linux, you can use **[Homebrew](https://brew.sh/)**, a package manager, to install the necessary tools.

To begin:
1. Clone the repository from GitHub:
```bash
git clone https://github.com/trigaten/Learn_Prompting_nextjs.git
```
2. Navigate to the project folder:
```bash
cd Learn_Prompting_nextjs
```

### Run the Website Locally
Once the setup is complete, you can run the website locally to preview your changes:

1. Ensure you are using Node.js version **18.0.0** or higher:
```bash
node -v
```
2. Install the required Node.js modules:
```bash
npm install
```
3. Run the website in development mode:
```bash
npm run dev
```

This will start a local development server, and your changes will be reflected live in the browser.

## ❤️ A Huge Thanks to All Contributors
We’re grateful for all the amazing contributions from our community! 🙌
Check out our contributors below:

<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>

## Cite

Expand Down
Binary file added astronaut_welcome.webp
Binary file not shown.

0 comments on commit 668fd48

Please sign in to comment.