Skip to content

Commit

Permalink
Move readme images out of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattbrictson committed May 13, 2019
1 parent a815cbc commit d3c729f
Show file tree
Hide file tree
Showing 15 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ $ gem install tomo

An easy way to kick the tires is to view the `--help`.

![$ tomo --help](./docs/_readme_images/tomo-help.png)
![$ tomo --help](./readme_images/tomo-help.png)

#### Configuring a project

Let’s init a project to see how tomo is configured.

![$ tomo init](./docs/_readme_images/tomo-init.png)
![$ tomo init](./readme_images/tomo-init.png)

The `.tomo/config.rb` file defines all the settings and tasks needed to setup and deploy a typical Rails project. An abbreviated version looks like this:

Expand Down Expand Up @@ -91,33 +91,33 @@ Eventually you'll want to edit the config file to specify the appropriate user a

With tomo, an initial deployment is separated into two distinct steps. The `setup` command prepares the host for its first deploy. Let’s take a look at the documentation with `--help`:

![$ tomo setup --help](./docs/_readme_images/tomo-setup-help.png)
![$ tomo setup --help](./readme_images/tomo-setup-help.png)

We can simulate the setup operation with the `--dry-run` option. Let's try it:

![$ tomo setup --dry-run](./docs/_readme_images/tomo-setup-dry-run.png)
![$ tomo setup --dry-run](./readme_images/tomo-setup-dry-run.png)

As you can see, the setup command in this project clones the git repository, installs ruby, node, bundler, and initializes the database. One the host is set up, it is ready for its first deploy.

#### Performing a deploy

Typically you only need to run `setup` once. From then on deploying a project is a matter of running the `deploy` command.

![$ tomo deploy --help](./docs/_readme_images/tomo-deploy-help.png)
![$ tomo deploy --help](./readme_images/tomo-deploy-help.png)

Like `setup`, this can be simulated with `--dry-run`, like this:

![$ tomo deploy --dry-run](./docs/_readme_images/tomo-deploy-dry-run.png)
![$ tomo deploy --dry-run](./readme_images/tomo-deploy-dry-run.png)

#### Running a single task

Tomo can also `run` individual remote tasks. Use the `tasks` command to see the list of tasks tomo knows about.

![$ tomo tasks](./docs/_readme_images/tomo-tasks.png)
![$ tomo tasks](./readme_images/tomo-tasks.png)

One of the built-in Rails tasks is `rails:console`, which brings up a fully-interactive Rails console over SSH. We can simulate this with `--dry-run` as well.

![$ tomo run rails:console --dry-run](./docs/_readme_images/tomo-run-rails-console-dry-run.png)
![$ tomo run rails:console --dry-run](./readme_images/tomo-run-rails-console-dry-run.png)

#### Writing tasks

Expand All @@ -143,7 +143,7 @@ plugin "./plugins/my-plugin.rb"

And run it!

![$ tomo run my-plugin:hello --dry-run](./docs/_readme_images/tomo-run-hello-dry-run.png)
![$ tomo run my-plugin:hello --dry-run](./readme_images/tomo-run-hello-dry-run.png)

#### Next steps

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion tomo.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
# Specify which files should be added to the gem when it is released.
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
spec.files = Dir.chdir(File.expand_path(__dir__)) do
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(docs|test|spec|features)/}) }
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(docs|readme_images|test|spec|features)/}) }
end
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
Expand Down

0 comments on commit d3c729f

Please sign in to comment.