docs: Update README and TODO
- Better structure for TODOs - Add information about JavaScript to README
This commit is contained in:
parent
0a5bc191d3
commit
759283fd9f
2 changed files with 136 additions and 116 deletions
16
README.md
16
README.md
|
|
@ -44,9 +44,23 @@ Everything has its default style.
|
|||
|
||||
CSS classes follow a naming scheme of `<object>_<description>`.
|
||||
|
||||
- *Object* usually is the name of the HTML element. If it is not a elemtn directly it is the thing which receives the styling
|
||||
- *Object* usually is the name of the HTML element. If it is not a element directly it is the thing which receives the styling
|
||||
- *Description* is a name of the style e.g. what it does, how it looks
|
||||
|
||||
### JavaScript (JS)
|
||||
|
||||
The codebase uses ECMAScript 2023 Language Specification (14th edition).
|
||||
However, currently the JSHint configuration only allows 11 as highest version.
|
||||
|
||||
ID values are written in *camelCase*. The scheme further uses parts for specific contexts.
|
||||
|
||||
If the ID is for an interactive element the first part is an abbreviation of the action.
|
||||
|
||||
- `qry` - Query
|
||||
- `set` - Set
|
||||
- `slt` - Select
|
||||
- `tgl` - Toggle
|
||||
|
||||
## Versioning
|
||||
|
||||
This project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://quelltext.interaktionsweise.de/interaktionsweise/hippie/tags).
|
||||
|
|
|
|||
12
TODO.md
12
TODO.md
|
|
@ -11,9 +11,15 @@
|
|||
- Add build process for normalize.css from github.com/necolas/normalize.css
|
||||
- Add build process for bourbon from https://github.com/thoughtbot/bourbon
|
||||
|
||||
# CSS
|
||||
|
||||
- Check style for every basic element
|
||||
- Uniform spelling of classes and identifiers
|
||||
|
||||
# Content
|
||||
|
||||
- Complete *Intro* with description for all basic elements, according to [HTML Standard - The elements of HTML](https://html.spec.whatwg.org/multipage/semantics.html#semantics)
|
||||
- *Intro*
|
||||
- Complete with description for all basic elements, according to [HTML Standard - The elements of HTML](https://html.spec.whatwg.org/multipage/semantics.html#semantics)
|
||||
- Sections
|
||||
- [x] body
|
||||
- [x] article
|
||||
|
|
@ -126,5 +132,5 @@
|
|||
- [ ] template
|
||||
- [ ] slot
|
||||
- [ ] canvas
|
||||
- Check style for every basic element
|
||||
- Uniform spelling of classes and identifiers
|
||||
- *Clock*
|
||||
- Add overlays to better distinguish day, week and year
|
||||
Loading…
Add table
Add a link
Reference in a new issue