mirror of https://github.com/kdl-org/kdl.git
write down some design principles to get started with
This commit is contained in:
parent
bb9562e4fc
commit
b4067bdfad
14
README.md
14
README.md
|
|
@ -14,6 +14,20 @@ kdl is still extremely new, and discussion about the format should happen over
|
||||||
on the [discussions page](https://github.com/kdoclang/kdl/discussions). Feel free
|
on the [discussions page](https://github.com/kdoclang/kdl/discussions). Feel free
|
||||||
to jump in and give us your 2 cents!
|
to jump in and give us your 2 cents!
|
||||||
|
|
||||||
|
## Design Principles
|
||||||
|
|
||||||
|
1. Maintainability
|
||||||
|
1. Flexibility
|
||||||
|
1. Cognitive simplicity
|
||||||
|
1. Ease of de/serialization
|
||||||
|
1. Ease of implementation
|
||||||
|
|
||||||
|
These are the guiding principles behind the design of KDL, in order of
|
||||||
|
importance. These principles will hopefully be useful in tie-breaking and
|
||||||
|
otherwise directing specific decisions when it comes down to it. They are
|
||||||
|
intentionally vague when it comes to specifics, but more concrete definitions
|
||||||
|
for each one will be settled on as the project matures.
|
||||||
|
|
||||||
## Implementations
|
## Implementations
|
||||||
|
|
||||||
* Rust: [kdl-rs](https://github.com/kdl-org/kdl-rs)
|
* Rust: [kdl-rs](https://github.com/kdl-org/kdl-rs)
|
||||||
|
|
|
||||||
2
SPEC.md
2
SPEC.md
|
|
@ -42,7 +42,7 @@ file/stream (an `EOF`).
|
||||||
|
|
||||||
When present in the list of Properties and Values, plain Values (those not
|
When present in the list of Properties and Values, plain Values (those not
|
||||||
attached to a Property), each "anonymous" value should be treated as a
|
attached to a Property), each "anonymous" value should be treated as a
|
||||||
Property whose key is its current index among _anonymous values_ in the same
|
Property whose key is its current index among _values_ in the same
|
||||||
node, starting from 0, as a string. Named properties do not count towarrds
|
node, starting from 0, as a string. Named properties do not count towarrds
|
||||||
this index.
|
this index.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue