Skip to content

Commit

Permalink
Add README (#3)
Browse files Browse the repository at this point in the history
and LICENSE
  • Loading branch information
garbas authored Apr 25, 2023
1 parent 3f0db16 commit 67baf87
Show file tree
Hide file tree
Showing 6 changed files with 375 additions and 0 deletions.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright 2023 FloxDev, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the “Software”), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
110 changes: 110 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
<h1 align="center">
<a href="https://floxdev.com" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="img/flox_orange_small.png" />
<source media="(prefers-color-scheme: light)" srcset="img/flox_blue_small.png" />
<img src="img/flox_blue_small.png" alt="flox logo" />
</picture>
</a>
</h1>

<h2 align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="img/harness_the_power_of_nix_dark.svg" />
<source media="(prefers-color-scheme: light)" srcset="img/harness_the_power_of_nix_light.svg" />
<img height="24" src="img/harness_the_power_of_nix_light.svg" alt="Harness the Power of Nix" />
</picture>
</h2>

<!-- TODO: here comes the graphic
show immediate value proposition
a short demo of basics would be good for now
a bold statement: Free yourself from container walls.
-->

<h3 align="center">
&emsp;
<a href="https://discourse.floxdev.com"><b>Discourse</b></a>
&emsp; | &emsp;
<a href="https://floxdev.com/docs"><b>Documentation</b></a>
&emsp; | &emsp;
<a href="https://floxdev.com/blog"><b>Blog</b></a>
&emsp; | &emsp;
<a href="https://twitter.com/floxdevelopment"><b>Twitter</b></a>
&emsp;
</h3>

<p align="center">
<a href="https://github.com/flox/install-flox-action/blog/main/LICENSE">
<img alt="GitHub" src="https://img.shields.io/github/license/flox/install-flox-action?style=flat-square">
</a>
<a href="https://github.com/flox/install-flox-action/blog/main/CONTRIBUTING.md">
<img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square"/>
</a>
<a href="https://github.com/flox/install-flox-action/releases">
<img alt="GitHub tag (latest by date)" src="https://img.shields.io/github/v/tag/flox/install-flox-action?label=Version&style=flat-square">
</a>
</p>

Installs [flox][flox-github] on GitHub Actions for the supported platforms:
Linux and macOS.

[flox][flox-website] is a command line tool that helps you **manage your
environments**. flox builds on top of the powerful ideas of [Nix][nix-website]
as well as making them accessible to everybody.


## 🚀 Getting Started

Create `.github/workflows/ci.yml` in your repo with the following contents:

```yml
name: "CI"

on:
pull_request:
push:

jobs:
tests:
runs-on: ubuntu-latest
steps:

- name: Checkout
uses: actions/checkout

- name: Install flox
uses: flox/install-flox-action

- name: Build
run: flox build
```
## 📫 Have a question? Want to chat? Ran into a problem?
We are happy to welcome you to our [Discourse forum][discourse] and answer your
questions! You can always reach out to us directly via the [flox twitter
account][twitter] or chat to us directly on [Matrix][matrix] or
[Discord][discord].
## 🤝 Found a bug? Missing a specific feature?
Feel free to [file a new issue][new-issue] with a respective title and
description on the the `flox/install-flox-action` repository. If you already
found a solution to your problem, we would love to review your pull request!


## 🪪 License

The install-flox-action is licensed under the MIT. See [LICENSE](./LICENSE).


[flox-github]: https://github.com/flox/flox
[flox-website]: https://floxdev.com
[new-issue]: https://github.com/flox/install-flox-action/issues/new/choose
[discourse]: https://discourse.floxdev.com
[twitter]: https://twitter.com/floxdevelopment
[matrix]: https://matrix.to/#/#flox:matrix.org
[discord]: https://discord.gg/mxUgrRGP
[nix-website]: https://nixos.org
Binary file added img/flox_blue_small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/flox_orange_small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
132 changes: 132 additions & 0 deletions img/harness_the_power_of_nix_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 67baf87

Please sign in to comment.