Skip to content

Commit 350d398

Browse files
committed
docs: cleaned up readme
1 parent 33d2741 commit 350d398

File tree

1 file changed

+6
-17
lines changed

1 file changed

+6
-17
lines changed

README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,34 +26,23 @@
2626

2727
Azul, spelled _/aˈzul/_ (i.e Hello in the Amazigh Language) is a modern and sleek icon pack using elements of Moroccan and Islamic architecture with the goal of having a unique and culturally close UI/UX for Moroccan users in apps, websites, manuals...
2828

29-
### ⚙ Project structure & Contributing
29+
### ⚙ Project structure
3030
The project is a monorepo, with plenty of room to expand to in the immediate future:
3131
| App/Package | Description |
3232
|----------|------------------|
3333
| [web](https://github.com/MadeByRetcy/azul/tree/stable/apps/web) | Contains the main website of the project (SvelteKit + TailwindCSS). |
3434
| [@azul/icons](https://github.com/MadeByRetcy/azul/tree/stable/packages/icons) | Contains the line icons (.svg) and serving logic (Typescript). |
3535

36-
To contribute to the website or any non-icon asset, please follow these basic rules:
37-
- Try your best to **account for edge cases** in code, if you can't you can try to extensively test your code to find those edge cases.
38-
- Speaking of edge cases, **make sure you test all of you code**, unit testing is primarily used.
39-
- Keep variable, function and type names **simple and clear, and representative of their purpose.**
40-
- Commit messages **should respect the [Conventional Commits Specification.](https://www.conventionalcommits.org/en/v1.0.0/)**
41-
- Apply the **DRY (Don't repeat yourself), SOLID (Methods should perform one action) & KISS (Keep it short and simple)** Paradigms
42-
- **Use [atomic commits](https://www.aleksandrhovhannisyan.com/blog/atomic-git-commits)** when possible to avoid unnecessary issues.
43-
- It's preferable if you use **4 Tabs indentation** and **adhere to common programming conventions** (Primarily JS/TS, CSS, HTML...) and **format your code appropriately** with [Prettier.](https://prettier.io/)
44-
- For projects that use TypeScript, **use types whenever possible!**
45-
4636
The website is hosted on Cloudflare Workers.
4737

48-
To contribute or suggest an icon:
49-
- Always use a `2px` stroke, and a black color.
50-
- You're free to use any vector editor you desire, the primary tool is Inkscape.
51-
- Always icons that are rounded playful and have ties to Moroccan culture, at the moment we're not planning to create any non-Morocco related icons but that may change in the future.
52-
- To keep with consistency, icon SVGs should `29px x 29px`
38+
>
39+
> [!NOTE]
40+
> To contribute please check the [`CONTRIBUTING` file](https://github.com/MadeByRetcy/azul/blob/stable/CONTRIBUTING.md) for more information!
41+
5342

5443
### 🪪 Licensing & Legal
5544
The project is split into two licenses:
5645
- **Non-icon assets:** Apache 2.0 License
5746
- **Icon assets & Logo:** CC BY 4.0 License
5847

59-
##### The code and assets of this project are a property of Made by Retcy and contributors.
48+
##### The code and _free_ assets of this project are a property of Made by Retcy and contributors.

0 commit comments

Comments
 (0)