Update README: set status & links to documentation
This commit is contained in:
parent
d64b895c43
commit
753944b492
3 changed files with 9 additions and 5 deletions
14
README.md
14
README.md
|
@ -10,8 +10,8 @@ Note: _rakenne_ means _structure_ in Finnish.
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
* :arrow_right: **define a DSL for modeling database**
|
* :arrow_right: **define a DSL for modeling database**
|
||||||
* :x: describe entity-relationship diagrams (ERD) using MERISE notation
|
* :arrow_right: describe entity-relationship diagrams (ERD) using MERISE notation ⇒ [doc/erd-dsl.md](doc/erd-dsl.md)
|
||||||
* :x: describe physical diagrams (PD)
|
* :arrow_right: describe physical diagrams (PD) ⇒ [doc/erd-dsl.md](doc/pd-dsl.md)
|
||||||
* :x: provide a command-line tool for all operations
|
* :x: provide a command-line tool for all operations
|
||||||
* :x: render models into diagrams
|
* :x: render models into diagrams
|
||||||
* :x: ERD to MERISE MCD diagrams
|
* :x: ERD to MERISE MCD diagrams
|
||||||
|
@ -42,11 +42,13 @@ Note: _rakenne_ means _structure_ in Finnish.
|
||||||
4. Push to the branch (`git push origin my-new-feature`)
|
4. Push to the branch (`git push origin my-new-feature`)
|
||||||
5. Create new Pull Request
|
5. Create new Pull Request
|
||||||
|
|
||||||
|
|
||||||
## Authors & contributors
|
## Authors & contributors
|
||||||
|
|
||||||
* [Glenn Y. Rolland](https://github.com/glenux) - creator and maintainer
|
* [Glenn Y. Rolland](https://github.com/glenux) - creator and maintainer
|
||||||
* You? Fork the project and become a contributor!
|
* You? Fork the project and become a contributor!
|
||||||
|
|
||||||
|
|
||||||
## Sponsors
|
## Sponsors
|
||||||
|
|
||||||
[Rakenne](https://github.com/glenux/rakenne) is an independent project whose development and maintenance is made possible thanks to the support of its patrons.
|
[Rakenne](https://github.com/glenux/rakenne) is an independent project whose development and maintenance is made possible thanks to the support of its patrons.
|
||||||
|
@ -55,12 +57,14 @@ If you wish to join them and support the work of its author, just participate wi
|
||||||
|
|
||||||
**>>> [Become a patron or sponsor on Patreon](https://www.patreon.com/glenux) <<<**
|
**>>> [Become a patron or sponsor on Patreon](https://www.patreon.com/glenux) <<<**
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Rakenne is Copyright © 2020 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE.txt file.
|
Rakenne is Copyright © 2020 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE.txt file.
|
||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
* https://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model
|
* [Wikipedia: Entity-relationship model](https://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model)
|
||||||
* https://www.lucidchart.com/pages/er-diagrams
|
* [Lucidchart: ER diagrams](https://www.lucidchart.com/pages/er-diagrams)
|
||||||
* https://www.youtube.com/watch?v=LR0Ip5Jenbk
|
* [Youtube: 04.5 - Règles de vérification du MCD](https://www.youtube.com/watch?v=LR0Ip5Jenbk)
|
||||||
|
|
||||||
|
|
0
doc/erd-dsl.md
Normal file
0
doc/erd-dsl.md
Normal file
0
doc/pd-dsl.md
Normal file
0
doc/pd-dsl.md
Normal file
Loading…
Reference in a new issue