cleanup
This commit is contained in:
45
README.md
45
README.md
@@ -11,17 +11,24 @@ However please be aware:
|
||||
* It would be nice to mention in radar that the generator is based on this repository.
|
||||
* Also when you want to reuse the CSS and Styling: Change the font (it is a licensed font) and the colors (It using AOE CI)
|
||||
|
||||
## Installation
|
||||
## Use and build
|
||||
|
||||
Add the tech radar as a dependency
|
||||
```
|
||||
git clone git@github.com:AOEpeople/aoe_technology_radar.git
|
||||
cd aoe_technology_radar
|
||||
yarn
|
||||
yarn watch
|
||||
yarn add https://github.com/aoepeople/aoe_technology_radar.git
|
||||
```
|
||||
|
||||
_A new [browser tab](http://127.0.0.1:8080/techradar) should open up - wait
|
||||
until last command has finished and refresh._
|
||||
Build the radar
|
||||
```
|
||||
yarn aoe_technology_radar
|
||||
```
|
||||
|
||||
Serve
|
||||
```
|
||||
cd build
|
||||
python3 -m http.server 8080
|
||||
```
|
||||
Then open here: http://localhost:8080
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -62,27 +69,3 @@ the same name from older releases.
|
||||
|
||||
If an item is overwritten in a new release, the attributes from the new item are
|
||||
merged with the old ones and a new history entry is created for that item.
|
||||
|
||||
## Travis
|
||||
|
||||
* [](https://travis-ci.org/AOEpeople/aoe_technology_radar/)
|
||||
(master)
|
||||
|
||||
* [](https://travis-ci.org/AOEpeople/aoe_technology_radar/)
|
||||
(next)
|
||||
|
||||
## Todos
|
||||
|
||||
* [x] Add Icons
|
||||
* [x] Implement search
|
||||
* [ ] Finalize CSS
|
||||
* [x] Get contents for how-to-use page
|
||||
* [ ] Tagging Items (Show Tags / Linking related items automatically)
|
||||
* [ ] Filter by Tags in overview
|
||||
* [ ] Show item history on details (relevant with 2nd release)
|
||||
* [ ] Better semantic and SEO
|
||||
* [ ] Make mobile friendly
|
||||
* [ ] Add mobile navigation and search
|
||||
* [ ] Create more react components for already existing CSS comps
|
||||
* [ ] Refactor hardcoded subfolder in routing
|
||||
* [ ] Unit test for radar generation :see_no_evil:
|
||||
|
||||
Reference in New Issue
Block a user