Sha256: 7ba5c076d83dba0fcc22f47bf52a74a187845dca91aa342d9144b1b285f18d20

Contents?: true

Size: 1.6 KB

Versions: 2

Compression:

Stored size: 1.6 KB

Contents

:toc: macro
:toclevels: 5
:figure-caption!:

= <%= configuration.project_label %>

toc::[]

== Features

== Screencasts

== Requirements

. link:https://www.ruby-lang.org[Ruby].

== Setup
<% if configuration.build_setup %>

To set up the project, run:

[source,bash]
----
bin/setup
----
<% end %>

== Usage

== Development

To contribute, run:

[source,bash]
----
git clone <%= configuration.computed_project_url_source %>
cd <%= configuration.project_name %>
<% if configuration.build_setup %>
bin/setup
<% end %>
----

<% if configuration.build_console %>

You can also use the IRB console for direct access to all objects:

[source,bash]
----
bin/console
----
<% end %>

== Tests

To test, run:

[source,bash]
----
bin/rake
----

<% if configuration.build_license %>
== link:<%= configuration.computed_project_url_license %>[License]
<% end %>

<% if configuration.build_security %>
== link:<%= configuration.computed_project_url_security %>[Security]
<% end %>

<% if configuration.build_conduct %>
== link:<%= configuration.computed_project_url_conduct %>[Code of Conduct]
<% end %>

<% if configuration.build_contributions %>
== link:<%= configuration.computed_project_url_contributions %>[Contributions]
<% end %>

<% if configuration.build_versions %>
== link:<%= configuration.computed_project_url_versions %>[Versions]
<% end %>

<% if configuration.build_community %>
== link:<%= configuration.computed_project_url_community %>[Community]
<% end %>

== Credits

* Built with link:https://www.alchemists.io/projects/rubysmith[Rubysmith].
* Engineered by link:<%= configuration.author_url %>[<%= configuration.author_name %>].

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
rubysmith-4.5.0 lib/rubysmith/templates/%project_name%/README.adoc.erb
rubysmith-4.4.0 lib/rubysmith/templates/%project_name%/README.adoc.erb