Skip to content

Commit

Permalink
docs: update README (runfinch#134)
Browse files Browse the repository at this point in the history
Signed-off-by: Mrudul Harwani <mharwani@amazon.com>

Issue #, if available:

*Description of changes:*
Update README.md to reflect changes in runfinch#128

*Testing done:*



- [X] I've reviewed the guidance in CONTRIBUTING.md


#### License Acceptance

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
  • Loading branch information
mharwani authored and ahsan-z-khan committed Jan 11, 2023
1 parent 06a7100 commit 76861ed
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,11 @@ We have plans to create some more documentation and tutorials here geared toward

The installer will install Finch and its dependencies in its own area of your system, and it can happily coexist with other container development tools. Finch is a new project and not meant to be a direct drop-in replacement for other tools. Therefore, we don't recommend aliasing or linking other command names to `finch`.

### A note on volume mounts

The `run` command has a `-v` option for volume mounts. See `Volume flags` under [nerdctl run](/~https://github.com/containerd/nerdctl#whale-blue_square-nerdctl-run) for more details, if you're not familiar. This allows you to mount directories from your local host into your container. One thing to note with Finch: currently, only locations within `$HOME` are supported by the volume mount `-v` option. Specifying directories outside `$HOME` may cause unexpected behavior. Support for other mount locations will be added soon.

### Configuration

Finch has a simple and extensible configuration. A configuration file at `${HOME}/.finch/finch.yaml` will be generated on first run. Currently, this config file has options for system resource limits for the underlying virtual machine. These default limits are generated dynamically based on the resources available on the host system, but can be changed by manually editing the config file.

For a full list of configuration options, check [the struct here](pkg/config/config.go#L25).
For a full list of configuration options, check [the struct here](pkg/config/config.go#L30).

An example `finch.yaml` looks like this:

Expand Down

0 comments on commit 76861ed

Please sign in to comment.