@@ -20,20 +20,7 @@ re-com provides:
2020* a mostly [ Bootstrap] ( http://getbootstrap.com/ ) look, mixed with
2121 some [ Material Design Icons] ( http://zavoloklom.github.io/material-design-iconic-font/icons.html ) .
2222
23- In short, re-com attempts to provide the kind of UI basics you'd need to build a desktop-class SPA app.
24-
25- ## It Uses Flexbox
26-
27- The entire layout side of this library relies on
28- [ Flexbox] ( http://css-tricks.com/snippets/css/a-guide-to-flexbox/ )
29-
30- Now, pretty much every modern browser
31- [ has support for Flexbox] ( http://caniuse.com/#feat=flexbox ) so
32- this is probably a non-issue these days, unless you need to
33- support old versions of IE.
34-
35- We build desktop-class apps to run in controlled browser environments
36- like [ Electron] ( https://electron.atom.io ) . So, we know we're dealing with Chrome.
23+ In short, re-com attempts to provide the UI basics needed to build a desktop-class SPA app.
3724
3825## Warning: No Mobile Focus
3926
@@ -49,19 +36,27 @@ so we backed away from fully advanced, minified compilation.
4936
5037## So, Without Ado Being Any Furthered ...
5138
52- Start by [ looking at the demo] ( https://re-com.day8.com.au ) .
39+ Start by [ looking at the demo] ( https://re-com.day8.com.au ) , it:
40+ - Provides detailed documentation for each component
41+ - Provides interactive pages showing component use and flexibility.
5342
5443## Navigating The Source
5544
56- When you are running the demo app, look to the the right of each page's titles , and you'll see hyperlinks
57- which will take you to the associated source code. That's a convenient way to navigate to either
45+ When running the demo app, look to the right of each page's title , and you'll see hyperlinks
46+ that will take you to the associated source code. That's a convenient way to navigate to either
5847the components themselves or the demo code.
5948
60- When browsing more generally , look in the ` src ` directory or this repo, you'll notice
49+ When browsing the code , look in the ` src ` directory or this repo, you'll notice
6150two subdirectories:
6251
63- - re-com - the library itself - the components
64- - re-demo - the demo app, which shows how to use the components
52+ - src/re-com - the library itself - the components
53+ - src/re-demo - the demo app, which documents the components and shows how to use them
54+
55+ There's also:
56+ - ` run/resources/public ` contains assets (CSS, fonts, JS) that you'll likely need if you are developing an app based on ` re-com `
57+ - ` test/ ` with cljs.test suites for many components (e.g., box_test.cljs, selection_list_test.cljs).
58+ - ` docs/ ` containing notes about development tools and release procedures (note: the demo app has detailed documentation).
59+ - ` scripts/ ` with babashka utilities (e.g., ` add-at-macro ` for adding the ` at ` macro to legacy codebases)
6560
6661## Useful Commands
6762
@@ -124,6 +119,8 @@ two subdirectories:
124119
125120## Using re-com
126121
122+ For a fast start, use ` https://github.com/day8/re-frame-template ` to create your own app (add the ` +re-com ` option when using re-frsame-template).
123+
127124re-com is available from clojars. Add it to your project.clj dependencies:
128125
129126[ ![ Clojars Project] ( https://img.shields.io/clojars/v/re-com.svg )] ( https://clojars.org/re-com )
@@ -164,7 +161,7 @@ so you don't need to include it explicitly.
164161If you decide to use re-com, consider also using [ re-frame] ( https://github.com/day8/re-frame )
165162(an MVC-ish framework).
166163
167- Although both ` re-frame ` and ` re-com ` can be used independently of each other , they dovetail well.
164+ Although ` re-frame ` and ` re-com ` can be used independently, they dovetail well together .
168165
169166## Related projects
170167
@@ -174,7 +171,7 @@ Although both `re-frame` and `re-com` can be used independently of each other, t
174171
175172## The Missing Components
176173
177- * tree (not hard, just haven't needed one yet)
174+ * < s > tree (not hard, just haven't needed one yet) </ s >
178175* menus - there's a dropdown, but no cascading menus
179176* accordion
180177* maybe a dockable LHS navbar
@@ -205,7 +202,7 @@ details on creating issues and pull requests.
205202
206203### License
207204
208- Copyright © 2015-2021 Michael Thompson
205+ Copyright © 2015-2025 Michael Thompson
209206
210207Distributed under The MIT License (MIT) - See LICENSE.txt
211208
0 commit comments