Skip to content

Commit

Permalink
Updated in the Readme.md and Makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
vidhvath28 committed Sep 5, 2024
1 parent 01d5d5f commit efad356
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 7 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ build: clean

.PHONY: check
check: $(BINARY)
@crystal spec
@crystal spec --tag ~online

.PHONY: clean
clean:
@rm -f $(BINARY)

.PHONY: run
run: $(BINARY)
$(BINARY)
$(BINARY)
52 changes: 47 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,72 @@
# crystal2nix

Helps nixify crystal projects.
[<img src="https://nixos.org/logo/nixos-logo-only-hires.png" width="200" align="right" alt="NixOS">](https://nixos.org)

# Crystal2Nix

Crystal2Nix is a tool designed to generate Nix expressions for Crystal projects. It simplifies the process of managing dependencies and building Crystal applications within the Nix ecosystem.

## Features

- Automatically generates Nix expressions from `shard.yml` files.
- Supports Crystal projects with various dependencies.
- Building and managing Crystal applications.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)

## Installation

### Prerequisites

- [Nix](https://nixos.org/download.html) installed on your system.
- [Crystal](https://crystal-lang.org/install/) programming language installed.
>>>>>>> 0e63fe2 (init at 0.1.0)
## Installation

You don't need to install it. With nix installed you can just run it:
You don't need to install crystal2nix manually. With Nix installed on your system, you can run it directly using the following command:

`nix-shell -p crystal2nix --run crystal2nix`

## Usage

To generate a Nix expression for your Crystal project, simply run:

`crystal2nix`

## Development
## Testing

Unit Tests: These tests can be run within the Nix sandbox without requiring network connectivity.

`make check ` # Runs unit tests

## Future plans

We will welcome all help with open arms!
Support for Fossil resources: Expanding source control compatibility.
Additional integration test cases: Enhancing the robustness of our test suite.

## Contributing

We value contributions from the community. If you have suggestions, bug reports, or improvements, please submit them through GitHub issues or pull requests. Your involvement helps us make crystal2nix better for everyone.

1. Fork it (<https://github.com/your-github-user/crystal2nix/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## License

crystal2nix is licensed under the MIT License. You are free to use, modify, and distribute this software under the terms of this license.

## Contributors

- [Michael Fellinger](https://github.com/manveru)
- [Peter Hoeg](https://github.com/peterhoeg)
- [Vidhvath J](https://github.com/vidhvath28)

0 comments on commit efad356

Please sign in to comment.