diff --git a/Qrakhen.Qamp.Core/README.md b/README.md similarity index 90% rename from Qrakhen.Qamp.Core/README.md rename to README.md index 9965296..7506fc0 100644 --- a/Qrakhen.Qamp.Core/README.md +++ b/README.md @@ -1,5 +1,4 @@ # Q& -###### ~by Qrakhen ## About @@ -17,9 +16,9 @@ sharing it to the public anyway. ## Usage -To build Q&, you need nothing more than a C# compiler that supports .NET10. +To build **Q&**, you need nothing more than a C# compiler that supports .NET10. There are .NET8 compatible versions available, but they are not recommended, -as Q& utilizes all of the performance optimizations .NET10 has to offer. +as **Q&** utilizes all of the performance optimizations .NET10 has to offer. After cloning, a simple `dotnet build ./` in the root directory will suffice. @@ -47,8 +46,10 @@ Most basic Usage: ### Assignments -Q& has two distinct ways to assign a value to a variable: By reference `<&` or by value `<=`. -Using the auto-assignment operator `<~` will choose the correct assignment based on what +**Q&** has two distinct ways to assign a value to a variable: + - By reference `<&`, or + - By value `<=`. +Using the auto-assignment operator `<~`, **Q&** will choose the correct assignment based on what type the right-hand expression consists of. Primitive types will be assigned by value, any object values will be assigned by reference. This is strongly inspired by the behaviour that most interpeters implement.