Skip to content
This repository has been archived by the owner on Sep 20, 2023. It is now read-only.

Latest commit

 

History

History
97 lines (65 loc) · 2.88 KB

README.md

File metadata and controls

97 lines (65 loc) · 2.88 KB
Raw

Disclaimer

This repository is still Work In Progress. The aim being setup automatic generation of the Foundation's meta data. Because this is still a WIP, it is possible that statements made in this README.md are not yet implemented, see TODO for more information.

Foundation META

Foundation META contains all the meta data associated to the foundation libraries:

  • the Foundation Web Site's Hakyll sources;
  • the benchmark results of: unstable, stable and past releases;
  • the documentation of: unstable, stable and the past releases.

This repository also provides a useful development tool base on Shake to run the tests and benchmark of Foundation as you develop it.

Installation:

Requirements:

  • using stack (recommended);
  • the shake and open-browser packages

Compile the ShakeFile:

stack ghc --package shake --package open-browser -- ShakeFile.hs

Usage

The ShakeFile provides two different modes.

  • --foundation path/to/foundation: set the source directory to the foundation sources. If not set, the repository will be cloned;
  • --release: run the build on release mode.
  • --open: open the generated meta in browser.

Development

This is the default mode of the ShakeFile. Simply provides the path to the foundation sources you are working on (otherwise, ShakeFile will clone it for you in the shake_build directory.)

One of the most common use case is to generate the benchs of the source you are working on:

# build the ShakeFile
stack ghc -- ShakeFile.hs
# run the benchs and open the result in the browser
./ShakeFile --foundation <path/to/source> --open benchs

Release (--release)

To only use for publishing. WIP

TODO

  • automatic publication of the Foundation web site by Travis;
  • generation and publication of the documentation:
    • the documentation is not yet well generated;
    • Hakyll needs to be aware of the documentations tree (different versions);
  • generation and publication of the benchmark:
    • being able to compare 2 different version of foundation;
    • publication on the Hakyll website.
  • in devel mode, give option to open the html result in browser.

WWW

Currently just a quick placeholder site from # Start Bootstrap - Agency theme, and the first image of "buildings" that came up in a google search. hakyll is used for building our pages.

goals:

  • build some graphs capabilities from a directory full of CSVs
  • build some documentation capabilities
  • fill up placeholder with real information
  • add documentation, etc.

development:

stack build
stack exec site watch

then development pages are accessible on: http://localhost:8000/