Sha256: 75a86a1deb79e53494a9becc31ebcacc376d69889953c55349fb01cbeb2781da

Contents?: true

Size: 1.56 KB

Versions: 3

Compression:

Stored size: 1.56 KB

Contents

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

= <%= settings.project_label %>

toc::[]

== Features

== Requirements

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

== Setup

To set up project, run:

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

== Usage

== Development

To contribute, run:

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

<% if settings.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 settings.build_license %>
== link:<%= settings.computed_project_uri_license %>[License]
<% end %>

<% if settings.build_security %>
== link:<%= settings.computed_project_uri_security %>[Security]
<% end %>

<% if settings.build_conduct %>
== link:<%= settings.computed_project_uri_conduct %>[Code of Conduct]
<% end %>

<% if settings.build_contributions %>
== link:<%= settings.computed_project_uri_contributions %>[Contributions]
<% end %>

<% if settings.build_versions %>
== link:<%= settings.computed_project_uri_versions %>[Versions]
<% end %>

<% if settings.build_community %>
== link:<%= settings.computed_project_uri_community %>[Community]
<% end %>

== Credits

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

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
rubysmith-7.2.0 lib/rubysmith/templates/%project_name%/README.adoc.erb
rubysmith-7.1.0 lib/rubysmith/templates/%project_name%/README.adoc.erb
rubysmith-7.0.0 lib/rubysmith/templates/%project_name%/README.adoc.erb