From 108757efc8ab1e07e05005c8f02fccd30379e439 Mon Sep 17 00:00:00 2001 From: Amanda Sternberg Date: Tue, 9 Sep 2025 14:14:07 +0200 Subject: [PATCH 1/2] Improved README with clearer and more idiomatic English --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 04d5603a7..896413564 100644 --- a/README.md +++ b/README.md @@ -2,32 +2,31 @@ [![Build status](https://badge.buildkite.com/c9edf020a4aec976f9835e54751cc5409d843adbb66d043bd3.svg?branch=main)](https://buildkite.com/ankitects/anki-ci) -This repo contains the source code for the computer version of -[Anki](https://apps.ankiweb.net). +Welcome to the source code repository for **Anki**. It's a popular spaced repetition program that helps you remember things more efficiently using flashcards. -# About +## About Anki -Anki is a spaced repetition program. Please see the [website](https://apps.ankiweb.net) to learn more. +Anki is a spaced repetition program designed to make learning easier and more effective. Learn more on the [official website](https://apps.ankiweb.net). -# Getting Started +## Getting Started -### Anki Betas +### Using Anki Betas -If you'd like to try development builds of Anki but don't feel comfortable -building the code, please see [Anki betas](https://betas.ankiweb.net/) +If you'd like to try development builds of Anki but don't feel comfortable building the code yourself, check out the [Anki betas](https://betas.ankiweb.net/) -### Developing +### Developing Anki -For more information on building and developing, please see [Development](./docs/development.md). +For detailed instructions on building and contributing to Anki, please see our [Development Guide](./docs/development.md). ### Contributing -Want to contribute to Anki? Check out the [Contribution Guidelines](./docs/contributing.md). +We welcome contributions from everyone! To get started, please read the [Contribution Guidelines](./docs/contributing.md). ### Anki Contributors +A big thanks to all the people who have contributed to Anki: [CONTRIBUTORS](./CONTRIBUTORS) -# License +## License -Anki's license: [LICENSE](./LICENSE) +Anki is licensed under: [LICENSE](./LICENSE) From 0c4bd12e5f3b02c4b2354d409c2ce93aa3c381cd Mon Sep 17 00:00:00 2001 From: Amanda Sternberg Date: Wed, 10 Sep 2025 08:38:13 +0200 Subject: [PATCH 2/2] Fix formatting and add myself to CONTRIBUTORS --- CONTRIBUTORS | 1 + README.md | 14 +++++++------- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTORS b/CONTRIBUTORS index b03108e16..3956f3662 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -242,6 +242,7 @@ Lee Doughty <32392044+leedoughty@users.noreply.github.com> memchr Max Romanowski Aldlss +Amanda Sternberg ******************** diff --git a/README.md b/README.md index 896413564..e78d4e900 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ [![Build status](https://badge.buildkite.com/c9edf020a4aec976f9835e54751cc5409d843adbb66d043bd3.svg?branch=main)](https://buildkite.com/ankitects/anki-ci) -Welcome to the source code repository for **Anki**. It's a popular spaced repetition program that helps you remember things more efficiently using flashcards. +Welcome to the source code repository for **Anki**, a spaced repetition program that uses flashcards to make learning more effective. -## About Anki +## About -Anki is a spaced repetition program designed to make learning easier and more effective. Learn more on the [official website](https://apps.ankiweb.net). +Anki is a spaced repetition program designed to make learning easier and more effective. Learn more on the [official website](https://apps.ankiweb.net) ## Getting Started @@ -14,15 +14,15 @@ Anki is a spaced repetition program designed to make learning easier and more ef If you'd like to try development builds of Anki but don't feel comfortable building the code yourself, check out the [Anki betas](https://betas.ankiweb.net/) -### Developing Anki +### Developing -For detailed instructions on building and contributing to Anki, please see our [Development Guide](./docs/development.md). +For detailed instructions on building and contributing to Anki, see our [Development Guide](./docs/development.md) ### Contributing -We welcome contributions from everyone! To get started, please read the [Contribution Guidelines](./docs/contributing.md). +We welcome contributions from everyone! To get started, read the [Contribution Guidelines](./docs/contributing.md) -### Anki Contributors +### Contributors A big thanks to all the people who have contributed to Anki: [CONTRIBUTORS](./CONTRIBUTORS)