Skip to content
This repository was archived by the owner on Feb 29, 2024. It is now read-only.

Commit 656d434

Browse files
authored
Improve README (#15)
Add Usage, How does it work and contributing sections. Fixes #2
1 parent d2a7f63 commit 656d434

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
1-
# pathfinder
2-
Rails Template for MarsBased projects
1+
# Pathfinder
2+
3+
![Pathfinder](https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Mars_pathfinder_panorama_large.jpg/1200px-Mars_pathfinder_panorama_large.jpg)
4+
5+
Rails Template for MarsBased projects.
6+
7+
## Usage
8+
9+
The recommended way to use it is referencing the template directly from the Github repository.
10+
11+
```
12+
rails new new_app -m https://raw.githubusercontent.com/MarsBased/pathfinder/master/template.rb
13+
```
14+
15+
## How does it work
16+
17+
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.
18+
19+
For this reason, we have organized the project in several recipes that can be applied based on the user feedback.
20+
21+
The template.rb file will first clone the whole Pathfinder repository into a temporary local folder and then will execute itself.
22+
23+
## Contributing
24+
25+
You just need to clone the repository
26+
27+
```git clone git@github.com:MarsBased/pathfinder.git```
28+
29+
make the desired changes and test it locally by using:
30+
31+
```rails new new_app -m pathfinder_local_repo/template.rb```

0 commit comments

Comments
 (0)