Author: Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com>
Redocument more what's the use of the project and it's idea
README.md | 48 ++++++++++++++++++++++++++++++++++++++----------
diff --git a/README.md b/README.md index 461f2f80224d41e70a90b731fd7bbb06aaab422f..2516bd1acfb3744eab1df67fddf317ee6071bbd9 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,51 @@ > UMBÓ: Cultuar (Iorubá/Português Brasileiro) Umbó is a minimal and modular CSS library. +## Philosophy + +The general idea is to have a decent and simple foundation to build +other applications within the idea of a accessible and popular web. + +We need to push forward more simple and content acessible +websites and to do that we can't build this on top of massive frameworks, excessive +styling and scripts, etc. We just need to deliver a idea, a message and +striping out the bloat/dirt of your website is a good starting point to do that. + +So instead, we offer to whoever use _umbó_, a very modular and go-to +architecture, built around simple stuff, like a common use Flexbox Grid, +minimal styling of tables, links and a good typography base. + +## Content + It's split into the following modules: -- Grid * -- Forms * -- Buttons * -- Utilities +- Grid +- Foundation (Typography, Links, Tables) +- Buttons +- Forms -_*These are included in the Base module_ +You can either include the minified version (weighing at 22kb/**3kb gzipped**) or +the standard version. -The project aims to be a nice and semantic foundation to build projects -with well stablished standards. +## Building -## CONTRIBUTING +We don't make use of unusual technology and/or bloated stuff. You can +clone the project, and take a peek at our [Makefile](https://linux.die.net/man/1/make), the whole code is +written in raw CSS and we include +a [.editorconfig](https://editorconfig.org) so we can keep a good standard. -Send patches and discussion at [porcellis@eletrotupi.com](mailto:porcellis@eletrotupi.com). +Then to build the project, simply open a shell and run: -## LICENSE +- `make` (to build the default/non-minified version) +- `make minify` (to build the default but minified version) +- `make $MODULE` (replace `$MODULE` with the module your looking after, +i.e. grid, foundation) + +## Contributing + +Send patches and discussion at my public inbox [~porcellis/public-inbox@lists.sr.ht](mailto:~porcellis/public-inbox@lists.sr.ht). + +## License GPL v3 - See [LICENSE](https://git.sr.ht/~porcellis/umbo/tree/master/LICENSE)