From 5603037b32f524a04eb5a128e83934db9a86141b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nenad=20Misi=C4=87?= Date: Wed, 26 Jun 2024 09:57:06 +0200 Subject: [PATCH] Update README.md (#46) * Update README.md * Test->Verify name --- .github/workflows/test.yml | 6 +-- README.md | 88 ++++++++++++++++++++++++++++++++++++-- 2 files changed, 88 insertions(+), 6 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 9aa27e36..b99a01d5 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,6 +1,6 @@ # This workflow will do a clean install of the dependencies and run tests across different versions -name: CI +name: Verify # Run this workflow every time a new commit is pushed to the repository on: @@ -36,7 +36,7 @@ jobs: uses: ludeeus/action-shellcheck@00cae500b08a931fb5698e11e79bfbd38e612a38 build: - name: Check build + name: Build and test runs-on: ubuntu-22.04 steps: @@ -57,7 +57,7 @@ jobs: run: bin/verify-exercises format: - name: Check Cairo formatting + name: Format Cairo files runs-on: ubuntu-22.04 steps: diff --git a/README.md b/README.md index fc0b7c7e..91e5fb2a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,61 @@ -# Exercism Cairo Track +
-[![configlet](https://github.com/exercism/cairo/workflows/configlet/badge.svg)](https://github.com/exercism/cairo/actions?query=workflow%3Aconfiglet) [![tests](https://github.com/exercism/cairo/workflows/test/badge.svg)](https://github.com/exercism/cairo/actions?query=workflow%3Atest) + +

Exercism Cairo Track

-Exercism exercises in Cairo. +![configlet](https://github.com/exercism/cairo/actions/workflows/configlet.yml/badge.svg)    ![test](https://github.com/exercism/cairo/actions/workflows/test.yml/badge.svg) + +
+ +Hi.  👋🏽  👋  **We are happy you are here.**  🎉 🌟 + +
+ +**`exercism/cairo`** is one of many programming language tracks on [exercism(dot)org][exercism-website]. +This repo holds all the instructions, tests, code, & support files for Cairo _exercises_ currently under development or implemented & available for students. + +Some Exercism language tracks have a **syllabus** which is meant to teach the language step-by-step. +The Cairo track's syllabus is a work in progress and it's not activated yet. +All exercises presented to students are **practice exercises**. +Students are expected to learn the language themselves, for example with the [official book][the-cairo-programming-language], and practice with our exercises. + +
+ +
+ + + + + +🌟🌟  Please take a moment to read our [Code of Conduct][exercism-code-of-conduct]  🌟🌟
+It might also be helpful to look at [Being a Good Community Member][being-a-good-community-member] & [The words that we use][the-words-that-we-use].
+Some defined roles in our community: [Contributors][exercism-contributors] **|** [Mentors][exercism-mentors] **|** [Maintainers][exercism-track-maintainers] **|** [Admins][exercism-admins] + +
+ +
+ + +We 💛 💙   our community.
+**`But our maintainers are not accepting community contributions at this time.`**
+Please read this [community blog post][freeing-maintainers] for details. + +
+ + +Here to suggest a new feature or new exercise?? **Hooray!**  🎉  
+We'd love if you did that via our [Exercism Community Forum](https://forum.exercism.org/).
+Please read [Suggesting Exercise Improvements][suggesting-improvements] & [Chesterton's Fence][chestertons-fence].
+_Thoughtful suggestions will likely result faster & more enthusiastic responses from volunteers._ + +
+ + +✨ 🦄  _**Want to jump directly into Exercism specifications & detail?**_
+     [Structure][exercism-track-structure] **|** [Tasks][exercism-tasks] **|** [Concepts][exercism-concepts] **|** [Concept Exercises][concept-exercises] **|** [Practice Exercises][practice-exercises] **|** [Presentation][exercise-presentation]
+     [Writing Style Guide][exercism-writing-style] **|** [Markdown Specification][exercism-markdown-specification] (_✨ version in [contributing][website-contributing-section] on exercism.org_) + +
## Testing @@ -41,3 +94,32 @@ Basic linting finished successfully: - Required track docs are present - Required shared exercise docs are present ``` + +
+ + +## Exercism Cairo Track License + +This repository uses the [MIT License](/LICENSE). + +[being-a-good-community-member]: https://github.com/exercism/docs/tree/main/community/good-member +[chestertons-fence]: https://github.com/exercism/docs/blob/main/community/good-member/chestertons-fence.md +[concept-exercises]: https://github.com/exercism/docs/blob/main/building/tracks/concept-exercises.md +[exercise-presentation]: https://github.com/exercism/docs/blob/main/building/tracks/presentation.md +[exercism-admins]: https://github.com/exercism/docs/blob/main/community/administrators.md +[exercism-code-of-conduct]: https://exercism.org/docs/using/legal/code-of-conduct +[exercism-concepts]: https://github.com/exercism/docs/blob/main/building/tracks/concepts.md +[exercism-contributors]: https://github.com/exercism/docs/blob/main/community/contributors.md +[exercism-markdown-specification]: https://github.com/exercism/docs/blob/main/building/markdown/markdown.md +[exercism-mentors]: https://github.com/exercism/docs/tree/main/mentoring +[exercism-tasks]: https://exercism.org/docs/building/product/tasks +[exercism-track-maintainers]: https://github.com/exercism/docs/blob/main/community/maintainers.md +[exercism-track-structure]: https://github.com/exercism/docs/tree/main/building/tracks +[exercism-website]: https://exercism.org/ +[exercism-writing-style]: https://github.com/exercism/docs/blob/main/building/markdown/style-guide.md +[freeing-maintainers]: https://exercism.org/blog/freeing-our-maintainers +[practice-exercises]: https://github.com/exercism/docs/blob/main/building/tracks/practice-exercises.md +[suggesting-improvements]: https://github.com/exercism/docs/blob/main/community/good-member/suggesting-exercise-improvements.md +[the-words-that-we-use]: https://github.com/exercism/docs/blob/main/community/good-member/words.md +[website-contributing-section]: https://exercism.org/docs/building +[the-cairo-programming-language]: https://book.cairo-lang.org/