You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Or file a new bug-report or feature request in the https://github.com/AvaloniaUI/Avalonia.Samples/issues[`Issues`]-section.
24
24
25
25
26
+
[#_organization_of_the_samples]
26
27
== 📂 Organization of the Samples
27
28
28
-
Every sample can be found in its own sub-folder and can run without any reference to another sample.Nevertheless we have a `*.sln`-File which has all projects in one solution, if you are looking for a complete collection of samples.
29
+
Every sample can be found in its own sub-folder and can run without any reference to another sample.Nevertheless we have a `*.sln`-File which has all projects in one solution, if you are looking for a complete collection of samples.
29
30
30
-
You can find the list of samples <<samples,below>>.The samples are structured in different categories and difficulties.For better search results, each sample is also tagged with some **buzz-words**.
31
+
You can find the list of samples <<samples,below>>.The samples are structured in different categories and difficulties.For better search results, each sample is also tagged with some **buzz-words**.
31
32
32
-
In every sample folder you will find a `README`-File, which describes the sample in detail and, if applicable, has links to further information and documentation.
33
+
In every sample folder you will find a `README`-File, which describes the sample in detail and, if applicable, has links to further information and documentation.
33
34
35
+
36
+
[#_difficulties]
34
37
=== 🐣 Difficulties
35
38
36
-
Each sample is tagged with it's difficulty.The degree of difficulty describes how much base-knowledge a user should have.
39
+
Each sample is tagged with it's difficulty.The degree of difficulty describes how much base-knowledge a user should have.
37
40
38
41
39
42
[cols="1,1,2"]
40
43
|===
41
-
| 🔘 | Difficulty | Degree of knowledge
44
+
| 🔘 | Difficulty | Degree of knowledge
42
45
43
46
| 🐣 | Beginner
44
-
| A Beginner must not have any knowledge of Avalonia. Nevertheless some basic knowledge of `C#`, `X(A)ML` and your IDE is mandatory
47
+
| A Beginner must not have any knowledge of Avalonia. Nevertheless some basic knowledge of `C#`, `X(A)ML` and your IDE is mandatory
45
48
46
-
| 🐥 | Easy
47
-
| Some very basic knowledge of Avalonia is needed
49
+
| 🐥 | Easy
50
+
| Some very basic knowledge of Avalonia is needed
48
51
49
-
| 🐔 | Normal
50
-
| The user is somewhat experienced with Avalonia
52
+
| 🐔 | Normal
53
+
| The user is somewhat experienced with Avalonia
51
54
52
-
| 🐉 | Hard
53
-
| These samples are focusing on non-standard tasks, which most users will not need to know.
55
+
| 🐉 | Hard
56
+
| These samples are focusing on non-standard tasks, which most users will not need to know.
54
57
55
58
|===
56
59
@@ -67,11 +70,12 @@ Each sample is tagged with it's difficulty. The degree of difficulty describes h
Is Anything missing?Have you found an error?Have you found an outdated sample?Or do you have a great idea?
224
+
Is Anything missing?Have you found an error?Have you found an outdated sample?Or do you have a great idea?
209
225
210
-
Fantastic!Your contribution is welcome.
226
+
Fantastic!Your contribution is welcome.
211
227
212
-
NOTE: Before you start, make sure you have read the Code of Conduct
228
+
NOTE: Before you start, make sure you have read the Code of Conduct
213
229
214
230
=== Code of Conduct
215
-
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.For more information see the https://dotnetfoundation.org/code-of-conduct[Contributor Covenant Code of Conduct]
231
+
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.For more information see the https://dotnetfoundation.org/code-of-conduct[Contributor Covenant Code of Conduct]
216
232
233
+
[#_issues_and_feature_requests]
217
234
=== Issues and Feature Requests
218
-
If you file a new issue or feature request please fill in the templates available.If you found an issue in an existing sample, please link the sample and if possible the point us to what is wrong.
235
+
If you file a new issue or feature request please fill in the templates available.If you found an issue in an existing sample, please link the sample and if possible the point us to what is wrong.
219
236
237
+
[#_pull_requests]
220
238
=== Pull Requests
221
239
222
-
NOTE: Pull requests may be discussed and probably not every pull request will be merged in the end.If you are not sure, please <<get-in-touch>> first.Anyway, every contribution is welcome.
240
+
NOTE: Pull requests may be discussed and probably not every pull request will be merged in the end.If you are not sure, please <<get-in-touch>> first.Anyway, every contribution is welcome.
223
241
242
+
[#_fixing_an_existing_sample]
224
243
==== Fixing an existing sample
225
244
226
-
If you find that in an existing sample, that something is unclear or missing, you can update this sample and file a pull request.Also spelling mistakes or wrong wording can be changed and a pull request can be send.
245
+
If you find that in an existing sample, that something is unclear or missing, you can update this sample and file a pull request.Also spelling mistakes or wrong wording can be changed and a pull request can be send.
227
246
228
-
IMPORTANT: If you change the difficulty or the buzz-words, remember to also update the main page.
247
+
IMPORTANT: If you change the difficulty or the buzz-words, remember to also update the main page.
229
248
249
+
[#_adding_a_new_sample]
230
250
==== Adding a new sample
231
251
232
252
. Add a new Project to the Solution `src ► Avalonia.Samples ► Avalonia.Samples.sln`
233
-
. In the root directory of the new sample add a `ReadMe`-file.We highly suggest to use the template which you can find here:
234
-
.. link:/_docs/AsciiDoc-Template/[AsciiDoc-Template]: If you want to provide richer content, we suggest to use the https://asciidoc.org[ascii-doc]-template.
235
-
.. link:/_docs/Markdown-Template/[Markdown-Template]: If you don't like option a), you can use also the Markdown-template.
253
+
. In the root directory of the new sample add a `ReadMe`-file.We highly suggest to use the template which you can find here:
254
+
.. link:/_docs/AsciiDoc-Template/[AsciiDoc-Template]: If you want to provide richer content, we suggest to use the https://asciidoc.org[ascii-doc]-template.
255
+
.. link:/_docs/Markdown-Template/[Markdown-Template]: If you don't like option a), you can use also the Markdown-template.
0 commit comments