Skip to content
This repository was archived by the owner on Feb 29, 2024. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# pathfinder
Rails Template for MarsBased projects
# Pathfinder

![Pathfinder](https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Mars_pathfinder_panorama_large.jpg/1200px-Mars_pathfinder_panorama_large.jpg)

Rails Template for MarsBased projects.

## Usage

The recommended way to use it is referencing the template directly from the Github repository.

```
rails new new_app -m https://raw.githubusercontent.com/MarsBased/pathfinder/master/template.rb
```

## How does it work

Usually, Rails templates are being built from a single template file. However, if you want to create more complex templates, managing everything this way is painful.

For this reason, we have organized the project in several recipes that can be applied based on the user feedback.

The template.rb file will first clone the whole Pathfinder repository into a temporary local folder and then will execute itself.

## Contributing

You just need to clone the repository

```git clone git@github.com:MarsBased/pathfinder.git```

make the desired changes and test it locally by using:

```rails new new_app -m pathfinder_local_repo/template.rb```