Packages

Griffin framework project generator. Provides a `mix grf.new` task to bootstrap a new Elixir application with Griffin dependencies and boilerplate code.

Current section

Files

Jump to
grf_new priv templates README.md
Raw

priv/templates/README.md

# <%= @app_name %>
To generate your Griffin website:
* Install dependencies with `mix deps.get`
* Build your website from template files with `mix grf.build`
<!-- * Spin up an HTTP server with `mix grf.server` or inside IEx with `iex -S mix grf.server` -->
You can now deploy the files generated in `<%= @output_path %>`
<!-- or use the bundled HTTP server to view the files at [`localhost:4000`](http://localhost:4000) from your browser. -->
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/griffin_ssg/deployment.html).
## Learn more
* Guides: https://hexdocs.pm/griffin_ssg/overview.html
* Docs: https://hexdocs.pm/griffin_ssg
* Source: https://github.com/elixir-griffin/griffin